Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
The ID of the category
Language code of the category
Set this to true, if you are displaying the category to the end-user. If true, the content of snippets or variables appears in the category. Note: If the value is true, ensure that the article content is not passed for update category endpoints.
To get latest published article, set isPublished as true.
Set this to false to exclude appending SAS token for images/files
Success
This is an example for get category page succes response. \n Here you can view diffrent data included with multiple Authors associated with a category page.
{
"category": {
"id": "5b291e6b-fa40-4ab9-941e-f8fffc23b376",
"title": "IndexPage",
"content": "Content is the information contained within communication media. This includes internet, cinema, television, radio, audio CDs, books, magazines, physical art, and live event content. It’s directed at an end-user or audience in the sectors of publishing, art, and communication",
"html_content": "Content is the information contained within communication media. This includes internet, cinema, television, radio, audio CDs, books, magazines, physical art, and live event content. It’s directed at an end-user or audience in the sectors of publishing, art, and communication
\n",
"block_content": null,
"parent_category_id": null,
"project_document_version_id": "46f48bc7-760f-4b07-b2d2-fce4aa8ba234",
"version_number": 1,
"public_version": 1,
"latest_version": 1,
"enable_rtl": true,
"hidden": false,
"status": 0,
"created_by": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"authors": [
{
"id": "f11efc6f-e968-4e95-82eb-85ad61559de8",
"first_name": "peter",
"last_name": "jone",
"email_id": "peterjone@mail.com",
"profile_logo_url": "https://www.gravatar.com/avatar/FE29D578CBEC3945FC88BF4F10906A3E?sv=2022-11-02&st=2024-06-18T07%3A12%3A34Z&se=2024-06-18T07%3A32%3A34Z&sr=b&sp=r&sig=LEA2ccLr1hMTZkAE48jsdaTYgRr6jNScPQ4x4E3vTss%3D",
"user_role": 7,
"last_login_at": "2024-06-13T14:30:00Z",
"unique_user_name": "peter-jone",
"sso_user_type": 0,
"is_sso_user": false
}
],
"created_at": "2024-06-13T14:30:00Z",
"modified_at": "2024-06-13T14:30:00Z",
"slug": "indexpage",
"is_fall_back_content": true,
"stale_status": {
"article_stale_status": 0,
"stale_reason": "",
"expired_at": "2024-06-13T14:30:00Z"
},
"content_type": "Markdown",
"is_block_editor": false
},
"extension_data": null,
"success": true,
"errors": [],
"warnings": [],
"information": []
}Get category version data
The ID of the category
Category title
Category page Markdown content
Category page WYSIWYG(HTML) content
Category page Advanced WYSIWYG content
Parent category ID
Project document version ID
The currently fetched version number of this category page
The version number that is currently published
The latest version number(revision) of this category page.
Indicates if Right to Left alignment is enabled for the category page language
Indicates if the category page is visible on the site
The status of the article: 0 - Draft, 3 - Published
The ID of the user that created the category page
The list of authors that contributed to this category page
SSO user type 0 - Normal user, 1 - SSO user, 2 - Invited SSO user
The date the category page was created
The date the category page was last modified
The slug of the category page
Indicates whether the category page content is a fallback of the default language content or not
Fresh - Category page is up-to-date Stale - Category page requires review
The status of the article: 0 - None, 1 - New, 2 - Updated, 3 - Custom
0 - Markdown 1 - WYSIWYG(HTML) 2 - Advanced WYSIWYG
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
Kindly verify the Categotry Id, version Number and Langauage code, and peroform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Category not found",
"error_code": "400",
"custom_data": null
}
],
"warnings": [],
"information": []
}Kindly verify the version Number and language code, and peroform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "Category with Id ad6ef117-1e8f-4817-800b-6ed8e2304bf2 with the language code en does not contain version 2",
"error_code": "400",
"custom_data": null
}
],
"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