Docs API Reference Knowledge Base/bff/kb/list

/bff/kb/list

Paginated per-tenant listing with kind / status / source / tag filters and an optional trigram-backed free-text filter. Accepts both legacy (query, offset, tag) and DataGrid (filterFulltextQuery, page, tagFilter) conventions. Newest entries first. Distinct from /kb/search in that this endpoint is filter-first and returns every match; /kb/search is the hybrid-retrieval ranked top-N.

Knowledge BasegetBffKbList

Parameters

10 query

Query parameters

· 10

querystringOptional

Free-text filter (legacy alias for filterFulltextQuery).

Exampleexample_query

filterFulltextQuerystringOptional

Free-text filter — DataGrid fulltext filter maps to this key.

Exampleexample_filterFulltextQuery

kindstringOptional

Comma-separated list of kinds to include.

Exampleqa,note

statusstringOptional

Exampledraft,active

sourcestringOptional

Examplechat,manual

tagstringOptional

Single tag exact match (legacy).

Exampleexample_tag

tagFilterstringOptional

Comma-separated tags (DataGrid tag-filter convention). First tag wins.

Exampleexample_tagFilter

limitstringOptional

Page size. Default 50, cap 200.

Exampleexample_limit

offsetstringOptional

Offset-based pagination (legacy).

Exampleexample_offset

pagestringOptional

1-based page number (DataGrid convention).

Exampleexample_page

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json

{
  "success": true
}

Request example

GET /bff/kb/list

get

curl -X GET "https://api.bizkithub.com/bff/kb/list?query=example_query&filterFulltextQuery=example_filterFulltextQuery&kind=qa%2Cnote&status=draft%2Cactive&source=chat%2Cmanual&tag=example_tag&tagFilter=example_tagFilter&limit=example_limit&offset=example_offset&page=example_page" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key