Categories
List Categories
This endpoint gets all categories from your Knowledge Base.
Copy
curl --location --request GET 'https://www.pacekb.com/api/v2/categories' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <api_key>' \
Copy
{
"success": true,
"data": [
{
"other_categories_categories_language_parentTocategories": [
{
"language": "fr"
}
],
"id": "<id>",
"name": "Getting Started",
"order_by": 200,
"users_categories_created_byTousers": {
"username": "benj",
"first_name": "Ben",
"last_name": "Jenkins",
"email_address": "ben@example.com"
},
"article_relationships": {
"added_date": "2023-06-05T20:42:23.805Z",
"category_id": "<id>",
"id": "<id>",
"site_id": "<id>",
},
"other_categories_categories_parent_idTocategories": {
"name": "PaceKB"
}
}
]
}
Response
Indicates whether the call was successful.
If there’s an error an accompanying error message will be visible
List of all categories
Show Toggle object in array
Show Toggle object in array
An array of all languages associated with this category in the format of {language: ‘fr’}
The unique ID of the category
The name of the category
Numbered priority of how the category should display
Array of all article relationships of published articles
Parent category (if exists)
Array of all language codes your Knowledge Base has enabled
Your limit of articles
Copy
curl --location --request GET 'https://www.pacekb.com/api/v2/categories' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <api_key>' \
Copy
{
"success": true,
"data": [
{
"other_categories_categories_language_parentTocategories": [
{
"language": "fr"
}
],
"id": "<id>",
"name": "Getting Started",
"order_by": 200,
"users_categories_created_byTousers": {
"username": "benj",
"first_name": "Ben",
"last_name": "Jenkins",
"email_address": "ben@example.com"
},
"article_relationships": {
"added_date": "2023-06-05T20:42:23.805Z",
"category_id": "<id>",
"id": "<id>",
"site_id": "<id>",
},
"other_categories_categories_parent_idTocategories": {
"name": "PaceKB"
}
}
]
}
Copy
curl --location --request GET 'https://www.pacekb.com/api/v2/categories' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <api_key>' \
Copy
{
"success": true,
"data": [
{
"other_categories_categories_language_parentTocategories": [
{
"language": "fr"
}
],
"id": "<id>",
"name": "Getting Started",
"order_by": 200,
"users_categories_created_byTousers": {
"username": "benj",
"first_name": "Ben",
"last_name": "Jenkins",
"email_address": "ben@example.com"
},
"article_relationships": {
"added_date": "2023-06-05T20:42:23.805Z",
"category_id": "<id>",
"id": "<id>",
"site_id": "<id>",
},
"other_categories_categories_parent_idTocategories": {
"name": "PaceKB"
}
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.