Get settings for the Category

Updated on Dec 24, 2024

3 minute(s) read

Anand Murali

Prev Next

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

Success

Success Response

Getting settings status for category.

{
  "data": {
    "slug": "indexpage",
    "seo_title": "IndexPage",
    "description": null,
    "allow_comments": true,
    "show_table_of_contents": true,
    "featured_image_url": null,
    "tags": [],
    "status_indicator": 0,
    "status_indicator_expiry_date": null,
    "exclude_from_search": false,
    "exclude_from_ai_search": false,
    "related_articles": [],
    "content_type": 0,
    "is_acknowledgement_enabled": false
  },
  "extension_data": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}

Expand All

object

data

object | null

This is to get category settings data

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)

Category 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

exclude_from_ai_search

boolean

true - The AI search assistant will not fetch information from this page category; false - The AI search assistant will not exclude this page category while fetching information

related_articles

Array of object (RelatedArticleData) | null

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

object

string | null

The ID of the article

title

string | null

The title of the article

hidden

boolean

True indicates that the article is hidden

slug

string | null

The slug of the article

content_type

integer (int32)

0 - Markdown content; 1 - HTML content

Valid values[ 0, 1, 2 ]

is_acknowledgement_enabled

boolean

extension_data

object | null

Extention data for customer API response

success

boolean

Status indication for customer API response

errors

Array of object (BaseError) | null

Errors in the customer API response

object

extension_data

object | null

Thids is the Extention data object

stack_trace

string | null

Stack trace for error response message

description

string | null

Description for error cause

error_code

string | null

Error code for Api response

custom_data

object | null

property*

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

extension_data

object | null

Extention Data for customer Api warning

description

string | null

Warning description

warning_code

string | null

warning code for customer Api base response

information

Array of object (BaseInformation) | null

Information passed by the customer API response

object

extension_data

object | null

Extention data for customer Api response information

description

string | null

status description for customer Api response information

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": []
}

Expand All

object

extension_data

object | null

Extention data for customer API response

success

boolean

Status indication for customer API response

errors

Array of object (BaseError) | null

Errors in the customer API response

object

extension_data

object | null

Thids is the Extention data object

stack_trace

string | null

Stack trace for error response message

description

string | null

Description for error cause

error_code

string | null

Error code for Api response

custom_data

object | null

property*

warnings

Array of object (BaseWarning) | null

Warnings in the customer API response

object

extension_data

object | null

Extention Data for customer Api warning

description

string | null

Warning description

warning_code

string | null

warning code for customer Api base response

information

Array of object (BaseInformation) | null

Information passed by the customer API response

object

extension_data

object | null

Extention data for customer Api response information

description

string | null

status description for customer Api response information

Was this article helpful?