Loading…
Query your knowledge base to build in-app help experiences.
/api/v1/help-center/categories/Server or Client keyList all help center categories for your organization.
// Response 200 [ { "id": "cat-uuid-1", "name": "Getting Started", "slug": "getting-started", "description": "Learn the basics", "order": 0 }, { "id": "cat-uuid-2", "name": "Billing", "slug": "billing", "description": "Payments and invoices", "order": 1 } ]
/api/v1/help-center/categories/{id}/articles/Server or Client keyList published articles in a category. Supports pagination.
// Response 200 { "count": 5, "results": [ { "id": "art-uuid-1", "title": "How to create an account", "slug": "how-to-create-an-account", "category_id": "cat-uuid-1", "created_at": "2026-01-15T12:00:00Z", "updated_at": "2026-02-10T09:30:00Z" } ] }
/api/v1/help-center/articles/{id}/Server or Client keyGet a single published article with its full body content.
// Response 200 { "id": "art-uuid-1", "title": "How to create an account", "slug": "how-to-create-an-account", "body": "<p>To create an account, visit...</p>", "category": { "id": "cat-uuid-1", "name": "Getting Started", "slug": "getting-started", "description": "Learn the basics", "order": 0 }, "created_at": "2026-01-15T12:00:00Z", "updated_at": "2026-02-10T09:30:00Z" }
/api/v1/help-center/articles/search/Server or Client keyFull-text search across published articles with relevance ranking.
| Name | Type | Description |
|---|---|---|
q* | string | Search query |
limit | integer | Page size (default 20, max 100) |
offset | integer | Pagination offset |
curl "https://your-domain.com/api/v1/help-center/articles/search/?q=password+reset" \ -H "X-API-Key: bnc_cl_..."