Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
The ID of the project version
True - Articles will be excluded; False - Articles will be included
Get article in the project version that corresponds to the given language code. If the language code is empty, the default language of the project version will be taken into account
True - Include category description; False - Exclude category description
Success
200 response in get list of categories within project version
{
"data": [
{
"id": "f587e278-4205-4a07-a6b7-28dc9caf6f48",
"name": "Getting started",
"description": "This is the description of the getting started category.",
"project_version_id": "ad76e483-6ef7-4e43-b53f-4fe5e52sefw",
"order": 1,
"parent_category_id": null,
"hidden": false,
"articles": [
{
"id": "c31b0a18-5416-4cef-b165-83d9b52ada43",
"title": "Why did we build Document360?",
"public_version": 1,
"latest_version": 1,
"language_code": null,
"hidden": false,
"status": 0,
"order": 1,
"slug": "why-did-we-build-document360",
"content_type": null,
"translation_option": 0,
"is_shared_article": false,
"modified_at": null
}
],
"child_categories": [],
"icon": null,
"slug": "getting-started",
"language_code": null,
"category_type": 0,
"created_at": "2024-06-13T14:30:00Z",
"modified_at": "2024-06-13T14:30:00Z",
"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
The content type of the article: Markdown = 0, Wysiwyg = 1, Block = 2
The Translation status of the article
True indicates that the article is shared
Article modified date time
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 page type category: 0 - Draft, 3 - Published
The content type of the page type category: Markdown = 0, Wysiwyg = 1, Block = 2
Extention data for customer API response
Status indication for customer API response
Errors in the customer API response
Thids is the Extention data object
Stack trace for error response message
Description for error cause
Error code for Api response
Warnings in the customer API response
Extention Data for customer Api warning
Warning description
warning code for customer Api base response
Information passed by the customer API response
Extention data for customer Api response information
status description for customer Api response information
Bad Request
400 response in get list of categories within project version
{
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}Extention data for customer API response
Status indication for customer API response
Errors in the customer API response
Thids is the Extention data object
Stack trace for error response message
Description for error cause
Error code for Api response
Warnings in the customer API response
Extention Data for customer Api warning
Warning description
warning code for customer Api base response
Information passed by the customer API response
Extention data for customer Api response information
status description for customer Api response information