Skip to main content
GET
/
articles
List all articles
curl --request GET \
  --url https://{your-subdomain}.neetokb.com/api/external/v2/articles \
  --header 'X-Api-Key: <x-api-key>'
{
  "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-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

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

Use the X-Api-Key header to provide your workspace API key. 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[]
​
pagination
object