List all categories
curl --request GET \
--url https://{your-subdomain}.neetokb.com/api/external/v2/categories \
--header 'X-Api-Key: <x-api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<x-api-key>'}};
fetch('https://{your-subdomain}.neetokb.com/api/external/v2/categories', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{your-subdomain}.neetokb.com/api/external/v2/categories"
headers = {"X-Api-Key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"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
}
}Categories
List categories
This API allows to get a list of categories. By default it returns the category tree, which omits categories without published articles and hides private categories from API-key callers. Pass flat=true to get every category, including empty and private ones, as flat rows.
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>'const options = {method: 'GET', headers: {'X-Api-Key': '<x-api-key>'}};
fetch('https://{your-subdomain}.neetokb.com/api/external/v2/categories', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{your-subdomain}.neetokb.com/api/external/v2/categories"
headers = {"X-Api-Key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"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
Learn how to find your subdomain in Workspace subdomain.
{your-subdomain} with your workspace’s subdomain. Learn how to find your subdomain in Workspace subdomain.
Headers
Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.
Query Parameters
When true, returns every category as a flat row with is_private and article counts.
Page of results to retrieve, starting from 1. Defaults to 1 when omitted.
Number of results per page. Defaults to 30 when omitted.
Response
200 - application/json
OK - Request succeeded
- Option 1
- Option 2
Hide child attributes
Hide child attributes