v1

latestOpenAPI 3.0.02026-07-26254134307.1 KB

Knowledge Base Articles

List articles in a knowledge base

Required scope: knowledge_bases:read

get/knowledge_bases/{knowledge_base_id}/articles

Path parameters

knowledge_base_idstring required

The ID of the knowledge base

Query parameters

limitinteger

Example:25

Max number of results per page

page_tokenstring

Example:https://yourCompany.api.frontapp.com/endpoint?limit=25&page_token=92f32bcd7625333caf4e0f8fc26d920c812f

Token to use to request the next page

Response

Array of knowledge base articles

Example response

{
  "_pagination": {
    "next": "https://yourCompany.api.frontapp.com/knowledge_bases/knb_1/articles?page_token=134287aba8eaa55cf366400c63300a75bab0c"
  },
  "_links": {
    "self": "https://yourCompany.api.frontapp.com/knowledge_bases/knb_1/articles"
  },
  "_results": [
    {
      "_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
    }
  ]
}