Get
/v1/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
string Required

The ID of the category

Responses
200
400
Show example

Success

Collapse all

object

data
object

id
string 

The ID of the category


name
string 

Name of the category


project_version_id
string 

The ID of the project version where this category is located


order
integer 

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

The list of articles attached to this category


object

child_categories
Array of object

The list of categories attached to this category


object

icon
string 

Unicode representation of the icon or image URL


slug
string 

The slug of the category


language_code
string 


category_type
integer 

Valid values[0,1,2]
created_at
string 

Category created date time


modified_at
string 

Category modified date time


extension_data
object

success
boolean 

Status indication for customer Api response


errors
Array of object

Errors in the customer Api response


object

warnings
Array of object

Warning in the customer Api response


object

information
Array of object

Information passed by the customer Api response


object