v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB

Knowledge Base Categories

Get a knowledge base category

Fetches a knowledge base category.

Required scope: knowledge_bases:read

get/knowledge_base_categories/{category_id}

Path parameters

category_idstring required

The ID of the category to fetch

Response

A knowledge base category

idstring required

Unique identifier of the knowledge base category

slugstring required

URL slug of the category. Construct the full URL using the template of protocol/knowledge base domain/locale/slug, such as https://yourDomain.com/en/categories/2

is_hiddenboolean required

Is the category hidden from navigation and breadcrumbs (topics are accessed as direct links)

localesstring[] required

List of the locales the category supports

created_atnumber

Timestamp when the category was created

updated_atnumber

Timestamp when the category was updated

Example response

{
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/knowledge_base_categories/kbc_12",
    "related": {
      "knowledge_base": "https://yourCompany.api.frontapp.com/knowledge_bases/knb_12",
      "parent_category": "https://yourCompany.api.frontapp.com/knowledge_base_catgories/kbc_10",
      "articles": "https://yourCompany.api.frontapp.com/knowledge_base_categories/kbc_12/articles"
    }
  },
  "id": "kbc_12",
  "slug": "/categories/2",
  "created_at": 1622672452.363,
  "updated_at": 1654309308.278
}