Get category page content with an ID

Prev Next
Get
/v2/Categories/{categoryId}/versions/{langCode}/{versionNumber}
Security
API Key: api_token
Header parameter nameapi_token

The API token used for authenticating the request. This must be passed as a header parameter. To generate an API token, go to Settings > Knowledge base portal > API tokens. This token must correspond to a valid workspace and permission level.

Path parameters
categoryId
stringRequired

The ID of the category

versionNumber
integer (int32) Required

Version number of the category

langCode
stringRequired

Language code of the category

Default"en"
Query parameters
isForDisplay
boolean

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 category content is not passed for update category endpoints.

Defaultfalse
appendSASToken
boolean

Set this to false to exclude appending SAS token for images/files

Defaulttrue
Responses
200

Success

Success Response

This is an sample category data by category version.

{
  "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, "is_active": 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", "current_workflow_status_id": null, "is_block_editor": false }, "extension_data": null, "success": false, "errors": null, "warnings": [], "information": [] }
Expand All
object
category
object | null

Get category version data

id
string | null

The ID of the category

title
string | null

Category title

content
string | null

Category page Markdown content

html_content
string | null

Category page WYSIWYG(HTML) content

block_content
string | null

Category page Advanced WYSIWYG content

parent_category_id
string | null

Parent category ID

project_document_version_id
string | null

Project document version ID

version_number
integer (int32)

The currently fetched version number of this category page

public_version
integer (int32)

The version number that is currently published

latest_version
integer (int32)

The latest version number(revision) of this category page.

enable_rtl
boolean

Indicates if Right to Left alignment is enabled for the category page language

hidden
boolean

Indicates if the category page is visible on the site

status
integer (int32)

The status of the article: 0 - Draft, 3 - Published

Valid values[ 0, 3 ]
created_by
string | null

The ID of the user that created the category page

authors
Array of object (UserProfileCustomer) | null

The list of authors that contributed to this category page

object
id
string | null
first_name
string | null
last_name
string | null
email_id
string | null
profile_logo_url
string | null
user_role
integer (int32)
Valid values[ 1, 2, 3, 4, 7 ]
last_login_at
string (date-time) | null
unique_user_name
string | null
sso_user_type
integer (int32)

SSO user type 0 - Normal user, 1 - SSO user, 2 - Invited SSO user

Valid values[ 0, 1, 2 ]
is_sso_user
boolean
is_active
boolean
created_at
string (date-time)

The date the category page was created

modified_at
string (date-time)

The date the category page was last modified

slug
string | null

The slug of the category page

is_fall_back_content
boolean

Indicates whether the category page content is a fallback of the default language content or not

stale_status
object | null

Fresh - Category page is up-to-date Stale - Category page requires review

article_stale_status
integer (int32)

The status of the article: 0 - None, 1 - New, 2 - Updated, 3 - Custom

Valid values[ 0, 1 ]
stale_reason
string | null
expired_at
string (date-time)
content_type
string | null

0 - Markdown 1 - WYSIWYG(HTML) 2 - Advanced WYSIWYG

current_workflow_status_id
string | null

Current Workflow status of the article

is_block_editor
boolean
extension_data
object | null

Extension data for customer API response

success
boolean

Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.

errors
Array of object (BaseError) | null

A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.

object
extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null

A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.

object
extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null

Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.

object
extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.

400

Bad Request

Category not found

Kindly verify the Categotry Id 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": []
}
Version not found

Kindly verify the version Id and Langauage 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": []
}
Expand All
object
extension_data
object | null

Extension data for customer API response

success
boolean

Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.

errors
Array of object (BaseError) | null

A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.

object
extension_data
object | null

This is the Extension data object

stack_trace
string | null

A technical trace showing where the error occurred within the system. Intended for backend debugging.

description
string | null

A clear message explaining what caused the error. This helps quickly understand what went wrong.

error_code
string | null

A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.

custom_data
object | null

Any structured metadata for the error object.

property*
warnings
Array of object (BaseWarning) | null

A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.

object
extension_data
object | null

Extension Data for customer Api warning

description
string | null

A plain message that describes the warning and helps understand what should be reviewed.

warning_code
string | null

A short, predefined code that uniquely identifies the warning type.

information
Array of object (BaseInformation) | null

Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.

object
extension_data
object | null

Extension data for customer Api response information

description
string | null

A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.