Skip to main content
GET
/
categories
List all categories
curl --request GET \
  --url https://{your-subdomain}.neetokb.com/api/external/v2/categories \
  --header 'X-Api-Key: <x-api-key>'
{
  "categories": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "slug": "<string>",
      "sequence": 123,
      "parent_id": "<string>",
      "depth": 123,
      "articles_count": 123,
      "categories_count": 123,
      "total_articles_count": 123,
      "url": "<string>",
      "subcategories": "<array>",
      "ancestors": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "url": "<string>"
        }
      ],
      "children": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "articles": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "url": "<string>",
          "title": "<string>",
          "created_at": "<string>",
          "content": "<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

​
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.

Response

200 - application/json

OK - Request succeeded

​
categories
object[]
​
pagination
object