Knowledge Base API
GET/api/v1/kb-articles
Product availabilityAlgaPSAAlgaDesk

List knowledge base articles

Returns a paginated list of KB articles for the tenant, with optional status, audience, article_type, category_id, and free-text search filters. Each row includes the joined document name.

RBAC · document

Query parameters

pageintegerOptional
limitintegerOptional
statusstringOptional
audiencestringOptional
article_typestringOptional
category_idstring <uuid>Optional
searchstringOptional

Response body

Success response 200 · schema PaginatedKbArticleResponse

dataarray of KbArticleRequired
itemsobject
A knowledge base article and its metadata.
article_idstring <uuid>Required
tenantstring <uuid>Required
document_idstring <uuid>Required
Underlying document backing the article.
titlestringRequired
slugstringRequired
article_typestringRequired
Enum: how_tofaqtroubleshootingreference
audiencestringRequired
Enum: internalclientpublic
statusstringRequired
Enum: draftreviewpublishedarchived
category_idstring <uuid>Nullable
review_cycle_daysintegerNullable
next_review_datestringNullable
published_atstringNullable
published_bystring <uuid>Nullable
document_namestringNullable
Joined from the documents table.
created_atstring
updated_atstring
paginationobjectRequired
pageintegerRequired
limitintegerRequired
totalintegerRequired
totalPagesintegerRequired
hasNextbooleanRequired
hasPrevbooleanRequired
metaobject

Response codes

200
Paginated KB articles.
400
Invalid request.
401
API key missing/invalid.
403
Caller lacks the required document permission.
500
Unexpected error.