Channel Developers

Get an Article by ID and language

Property

Description

Method

GET

Path

/open/v1/spaces/$me/articles/{articleId}

Accept

-

Content-Type

application/json

Description

Retrieves an article from its current revision in the requested language by article ID and language.

  • Request

    • Query

      Param

      Required?

      Default

      Type

      Description

      Example

      language

      O

      -

      string

      Requested language

      ko

    • Body

      Plaintext
      // (empty)
  • Response

    TypeScript

Get an Article by Slug and language

Property

Description

Method

GET

Path

/open/v1/spaces/$me/articles/${slug}

Accept

-

Content-Type

application/json

Description

Retrieves an article from its current revision in the requested language by article slug and language.

  • Request

    • Query

      Param

      Required?

      Default

      Type

      Description

      Example

      language

      O

      -

      string

      Requested language

      ko

    • Body

      Plaintext
      // (empty)
  • Response

    TypeScript

Property

Description

Method

GET

Path

/open/v1/spaces/$me/articles/batch

Accept

-

Content-Type

application/json

Description

Retrieves multiple articles and its current revision in the requested language by article IDs and a language.Can fetch up to 25 articles.

  • Request

    • Query

      Param

      Required?

      Default

      Type

      Description

      Example

      ids[]

      O

      -

      string[]

      IDs of articles to fetch.

      ?ids[]=42&ids[]=37

      language

      O

      -

      string

      Requested language

      ko

    • Body

      Plaintext
      // (empty)
  • Response

    TypeScript

Property

Description

Method

GET

Path

/open/v1/spaces/$me/articles

Accept

-

Content-Type

application/json

Description

Retrieves a paginated list of articles in a space ordered by update timestamp.

  • Request

    • Query

      Param

      Required?

      Default

      Type

      Description

      Example

      language

      O

      -

      string

      Requested language

      ko

      state

      X

      -

      'published' | 'unpublished' | 'draft'

      If specified, the results will be from articles containing the given state

      published

      topicId

      X

      -

      string

      If specified, the results will be filtered by articles with the given topic attached

      42

      limit

      X

      25

      number

      Used for pagination

      25

      since

      X

      string

      Used for pagination

      1707017182188

      order

      X

      asc

      ‘asc’ | 'desc'

      Sort order

      asc

    • Body

      Plaintext
      // (empty)
  • Response

    TypeScript