Get
/v2/Categories/{categoryId}/versions/{langCode}/{versionNumber}
Security
API Key
Header parameter nameapi_token
Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
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.

Default"False"
appendSASToken
boolean

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

Default"True"
Responses
200
400
Show example

Success

Collapse all
object
category
object (CategoryVersionData)
id
string

The ID of the category

title
string

Category title

content
string

Category page content

html_content
string

Category page HTML content

block_content
string

Category page HTML block content

parent_category_id
string

Parent category ID

project_document_version_id
string

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 category page: 0 - Draft, 1 - In review, 2 - Public, 3 - Published, 4 - Deleted, 5 - Forked

Valid values[ 0, 1, 2, 3, 4, 5 ]
created_by
string

The ID of the user that created the category page

authors
Array of object (UserProfileCustomer)

The list of authors that contributed to this category page

object
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

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 (StaleStatus)
content_type
string

0 - Markdown content 1 - HTML content 2 - Block content

is_block_editor
boolean
extension_data
object (ExtensionDataObject)
success
boolean

Status indication for customer API response

errors
Array of object (BaseError)

Errors in the customer API response

object
warnings
Array of object (BaseWarning)

Warning in the customer API response

object
information
Array of object (BaseInformation)

Information passed by the customer API response

object