v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB

Knowledge Bases

Get a knowledge base

Fetches a knowledge base.

Required scope: knowledge_bases:read

get/knowledge_bases/{knowledge_base_id}

Path parameters

knowledge_base_idstring required

The ID of the knowledge base to fetch

Response

A knowledge base

idstring required

Unique identifier of the knowledge base

type'internal' | 'external' required

Type of the KB

localesstring[] required

List of the KB's possible locales

created_atnumber

Timestamp when the knowledge base was created

updated_atnumber

Timestamp when the knowledge base was updated

Example response

{
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/knowledge_bases/knb_12",
    "related": {
      "articles": "https://yourCompany.api.frontapp.com/knowledge_bases/knb_12/articles",
      "categories": "https://yourCompany.api.frontapp.com/knowledge_bases/knb_12/categories"
    }
  },
  "id": "knb_12",
  "type": "internal",
  "created_at": 1622672452.363,
  "updated_at": 1654309308.278
}