Knowledge Bank / REFERENCE

List knowledge categories

Return the category tree, active flags and article counts. Includes inactive categories for integration management.

GET/api/v1/kb/categories

Permissions kb:read

Parameters

Name	Description
`X-Luma-Workspace-Host`header · required	Your workspace host, e.g. acme.lumi-cx.com. Required on api.lumi-cx.com. This header never grants access: the Bearer key must belong to the selected workspace.

Responses

200 Successful operation

{
  "ok": true,
  "categories": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "parentId": "00000000-0000-4000-8000-000000000001",
      "nameEn": "example",
      "nameAr": "example",
      "slug": "example",
      "icon": "example",
      "sortOrder": 1,
      "active": false,
      "articleCount": 1,
      "children": []
    }
  ]
}

400 Invalid request

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

401 Missing, invalid, expired, revoked or wrong-workspace key

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

403 Required key permission missing, module unavailable, or workspace suspended

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

404 Record, workspace or route not found

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

409 Version changed or the resource is locked

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

429 Rate limit exceeded; respect Retry-After

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}

502 Upstream or unexpected server error

{
  "ok": false,
  "error": "invalid_body",
  "message": "example"
}