Enter REST API key. To generate a key, go to Settings â Knowledge base portal â API tokens
The ID of the category
If the language code is empty, the default language of the category will be taken into account.
Success
This is an example for get category succes response. \n Here you can view diffrent data included with multiple article associated with a category.
{
"data": {
"id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"name": "Category name",
"description": null,
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"order": 11,
"parent_category_id": null,
"hidden": false,
"articles": [
{
"id": "cf8f67da-77c7-48b1-b207-70875caa2f55",
"title": "New article 1",
"public_version": 1,
"latest_version": 1,
"language_code": "en",
"hidden": false,
"status": 0,
"order": 2,
"slug": "new-article-1",
"content_type": null,
"translation_option": 0,
"is_shared_article": false
},
{
"id": "925b69b9-f241-4d89-9e3e-208a98dfc8eb",
"title": "New article 2",
"public_version": 1,
"latest_version": 1,
"language_code": "en",
"hidden": false,
"status": 0,
"order": 2,
"slug": "new-article-2",
"content_type": null,
"translation_option": 0,
"is_shared_article": false
}
],
"child_categories": [
{
"id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"name": "Child category name",
"description": null,
"project_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"order": 11,
"parent_category_id": null,
"hidden": false,
"articles": [
{
"id": "cf8f67da-77c7-48b1-b207-70875caa2f55",
"title": "New article 3",
"public_version": 1,
"latest_version": 1,
"language_code": "en",
"hidden": false,
"status": 0,
"order": 2,
"slug": "new-article-3",
"content_type": null,
"translation_option": 0,
"is_shared_article": false
},
{
"id": "925b69b9-f241-4d89-9e3e-208a98dfc8eb",
"title": "New article 4",
"public_version": 1,
"latest_version": 1,
"language_code": "en",
"hidden": false,
"status": 0,
"order": 2,
"slug": "new-article-4",
"content_type": null,
"translation_option": 0,
"is_shared_article": false
}
],
"child_categories": [],
"icon": null,
"slug": "category-name",
"language_code": null,
"category_type": 2,
"created_at": "2024-04-09T11:35:32Z",
"modified_at": "2024-04-09T11:35:32Z",
"status": null,
"content_type": null
}
],
"icon": null,
"slug": "category-name",
"language_code": null,
"category_type": 2,
"created_at": "2024-04-09T11:35:32Z",
"modified_at": "2024-04-09T11:35:32Z",
"status": null,
"content_type": null
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}The ID of the category
Name of the category
Description of the category
The ID of the project version where this category is located
The position the category inside the parent category
The ID of the parent category ( null if top-level )
Indicates if the category is visible on the site ( If "false," all the child categories and articles will be hidden as well )
The list of articles attached to this category
The ID of the article
The article title
The article version number(revision) that is currently published
The latest version number of this article
The default language code
Indicates if the article is visible on the site
The status of the article: 0 - Draft, 3 - Published
The position of the article inside the parent category
The slug of the article
0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG
0 - None, 1 - Needs transation, 2 - Translated, 3 - In progress
True indicates that the article is shared
The list of categories attached to this category
Unicode representation of the icon or image URL
The slug of the category
Language code of the category
0 - Folder, 1 - Page, 2 - Index
Category created date time
Category modified date time
The status of the article: 0 - Draft, 3 - Published
0 - Markdown; 1 - WYSIWYG(HTML); 2 - Advanced WYSIWYG
Status indication for customer API response
Errors in the customer API response
Stack trace for error response message
Description for error cause
Error code for Api response
Warnings in the customer API response
Warning description
warning code for customer Api base response
Information passed by the customer API response
status description for customer Api response information
Bad Request
Kindly verify the Categotry Id, and peroform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Cannot find category with id 5b291e6b-fa40-4ab9-941e-f8fffc23b3761",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}Kindly verify the langCode, and peroform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Language code not found",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}Status indication for customer API response
Errors in the customer API response
Stack trace for error response message
Description for error cause
Error code for Api response
Warnings in the customer API response
Warning description
warning code for customer Api base response
Information passed by the customer API response
status description for customer Api response information