v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB

Knowledge Base Articles

Get a knowledge base article

Fetches a knowledge base article.

Required scope: knowledge_bases:read

get/knowledge_base_articles/{article_id}

Path parameters

article_idstring required

The ID of the article to fetch

Response

A knowledge base article

idstring required

Unique identifier of the knowledge base article

slugstring required

URL slug of the article. Construct the full URL using the template of protocol/knowledge base domain/locale/slug, such as https://yourDomain.com/en/articles/5

localesstring[] required

List of the locales the article supports

created_atnumber

Timestamp when the article was created

updated_atnumber

Timestamp when the article was updated

Example response

{
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/knowledge_base_articles/kba_12",
    "related": {
      "knowledge_base": "https://yourCompany.api.frontapp.com/knowledge_bases/knb_12",
      "category": "https://yourCompany.api.frontapp.com/knowledge_base_category/kbc_12",
      "content": "https://yourCompany.api.frontapp.com/knowledge_base_articles/kba_12/content"
    }
  },
  "id": "kba_12",
  "slug": "/articles/5",
  "created_at": 1622672452.363,
  "updated_at": 1654309308.278
}