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

langCode
stringRequired

Language code of the category

Default"en"
Responses
200
400
Show example

Success

Collapse all
object
data
object (CategorySettingsCustomer)
slug
string | null

The slug of the category

seo_title
string | null

SEO title of the category

description
string | null

SEO description of the category

allow_comments
boolean

Allow comments for category

show_table_of_contents
boolean

True - Table of Contents will be enabled False - Table of Contents will be disabled

featured_image_url
string | null

URL of the featured image

tags
Array of string | null

List of Tags associated to the category

string
status_indicator
integer (int32)

Article status in the knowledge base. 0 - None; 1 - New; 2 - Updated; 3 - Custom

Valid values[ 0, 1, 2, 3 ]
status_indicator_expiry_date
string (date-time) | null

The number of days after which the article status will be removed

exclude_from_search
boolean

true - The caetgory will not appear in search results in the knowledge base false - The category will appear in search results in the knowledge base

related_articles
Array of object (RelatedArticleData) | null

The list of related article IDs to show in the knowledge base

object
content_type
integer (int32)

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

Valid values[ 0, 1, 2 ]
extension_data
object (ExtensionDataObject)
success
boolean

Status indication for customer API response

errors
Array of object (BaseError) | null

Errors in the customer API response

object
warnings
Array of object (BaseWarning) | null

Warnings in the customer API response

object
information
Array of object (BaseInformation) | null

Information passed by the customer API response

object