Get
/v2/Categories/{categoryId}
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

Query parameters
langCode
string

If the language code is empty, the default language of the category will be taken into account.

Responses
200
400
Show example

Success

Collapse all
object
data
object (CategoryDataCustomer)
id
string

The ID of the category

name
string

Name of the category

description
string

Description of the category

project_version_id
string

The ID of the project version where this category is located

order
integer (int32)

The position the category inside the parent category

parent_category_id
string

The ID of the parent category ( null if top-level )

hidden
boolean

Indicates if the category is visible on the site ( If "false," all the child categories and articles will be hidden as well )

articles
Array of object (ArticleSimpleDataCustomer)

The list of articles attached to this category

object
child_categories
Array of object (CategoryDataCustomer)

The list of categories attached to this category

object Recursive
icon
string

Unicode representation of the icon or image URL

slug
string

The slug of the category

language_code
string

Language code of the category

category_type
integer (int32)

0 - Folder, 1 - Page, 2 - Index

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

Category created date time

modified_at
string (date-time)

Category modified date time

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