List all articles

This API allows to get a list of all articles.

GET /articles

Try it

List all articles

cURL

curl --request GET \
  --url https://{your-workspace}.neetokb.com/api/external/v1/articles \
  --header 'X-Api-Key: <x-api-key>'

200

{
  "articles": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "getting-started",
      "title": "Getting Started Guide",
      "state": "published",
      "unique_views_count": 42,
      "category": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    }
  ],
  "pagination": {
    "total_records": 123,
    "total_pages": 123,
    "current_page_number": 123,
    "page_size": 123
  }
}

Replace {your-workspace} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.

Headers

X-Api-Key · string · default: your-api-key · required

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

Query Parameters

category_id · string<uuid>

Unique identifier of the category. Refer to Getting the Category ID section for detailed instructions.

page_number · integer

Retrieve paginated results by specifying the desired page number. Defaulting to 1 when omitted.

page_size · integer

Set the number of results returned in the response. Defaulting to 30 when omitted.

search_term · string

Search term to filter articles.

state · enum<string>

Status of the article.

Available options: draft, published

Response

200 - application/json

OK - Request succeeded

articles · object[]

Hide child attributes

articles. id · string<uuid>

articles. slug · string

Example:

"getting-started"

articles. title · string

Example:

"Getting Started Guide"

articles. state · enum<string>

Available options: draft, published

Example:

"published"

articles. unique_views_count · integer

Example:

42

articles. category · object

Hide child attributes

articles.category. id · string<uuid>

articles.category. name · string

pagination · object

Hide child attributes

pagination. total_records · integer

pagination. total_pages · integer

pagination. current_page_number · integer

pagination. page_size · integer