Skip to main content
GET
List knowledge base documents and their interview limits

Authorizations

Authorization
string
header
required

Supabase JWT — Authorization: Bearer <token>.

Query Parameters

knowledge_base_id
string<uuid>

A document id (the knowledge_base_id of a listed document, not a store id): read this one document. Answers 404 if your token cannot see it, including when it is another company's. merchant_id and offset are ignored.

Example:

"44444444-4444-4444-8444-444444444444"

knowledge_base_store_id
string<uuid>

Only the documents of this knowledge base store. Omit for every store of the company.

Example:

"d9d6f121-1230-48fd-b3a7-8b5a1e8db052"

merchant_id
string<uuid>

Optional merchant to scope to. Admins and sub-merchant operators only; other callers always use their token's merchant.

Example:

"28106cba-1c27-4e53-b149-32113e5e8e31"

limit
integer
default:50

Maximum number of records to return (1–1000).

Required range: 1 <= x <= 1000
Example:

50

offset
integer | null
default:0

Number of records to skip from the start of the result set.

Required range: x >= 0
Example:

0

Response

A page of documents with pagination metadata.

data
object[]
required

The documents for this page with the interview limit of each, newest first.

pagination
object
required