Skip to main content
get/apps/annotations
Request example
Response
get/apps/annotations

Authorization

Authorizationstringheaderrequired#

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Query parameters

pageinteger#
Page number.

Default: 1

Range: >= 1

limitinteger#
Number of items per page. Requests above 100 are capped at 100.

Default: 20

Range: >= 1

keywordstring#
Keyword to filter annotations by question or answer content.

Responses

application/json
200
Successfully retrieved annotation list.
dataobject[]#
List of annotation items for the current page.
has_moreboolean#
true if more pages are available beyond the current result set.
limitinteger#
Number of items per page.
pageinteger#
Current page number.
totalinteger#
Total number of annotations matching the query.