List KB article categories

Returns the standard categories available for KB articles, ordered by display order then name.

RBAC · document

Response body

Success response 200 · schema KbCategoryListResponse

dataarray of objectRequired

itemsobject

category_idstring <uuid>Required

category_namestringRequired

display_orderinteger

Response codes

200

Available categories.

400

Invalid request.

401

API key missing/invalid.

403

Caller lacks the required document permission.

500

Unexpected error.

GET /api/v1/kb-articles/categories

cURL

curl -X GET "https://algapsa.com/api/v1/kb-articles/categories" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/kb-articles/categories", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/v1/kb-articles/categories");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": [
    {
      "category_id": "01HN2K7VRB9PQ3Y0000000000",
      "category_name": "string",
      "display_order": 1
    }
  ]
}