API Reference
Knowledge Base Endpoint
List and retrieve knowledge base articles via the API.
List articles
GET /knowledge-baseScopes required: tickets:read
Query parameters:
| Parameter | Type | Description |
|---|---|---|
query | string | Full-text search query |
status | string | Filter by status: published, draft |
limit | number | Results per page (default: 20, max: 100) |
cursor | string | Pagination cursor |
Response:
{
"articles": [
{
"id": "art_01abc...",
"title": "How to track your order",
"slug": "how-to-track-your-order",
"status": "published",
"excerpt": "You can track your order using the tracking number...",
"createdAt": "2025-01-01T00:00:00Z",
"updatedAt": "2025-01-10T00:00:00Z"
}
],
"nextCursor": null
}Get an article
GET /knowledge-base/:idScopes required: tickets:read
Returns the full article including the body content:
{
"id": "art_01abc...",
"title": "How to track your order",
"slug": "how-to-track-your-order",
"status": "published",
"body": "## Tracking your order\n\nAfter your order ships...",
"excerpt": "You can track your order using the tracking number...",
"createdAt": "2025-01-01T00:00:00Z",
"updatedAt": "2025-01-10T00:00:00Z"
}body is returned as Markdown.
The knowledge base API is read-only. To create or edit articles, use the Ticket0 app or the website crawl import feature.