Skip to main content
GET
List Annotations

Authorizations

Authorization
string
header
required

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

page
integer
default:1

Page number.

Required range: x >= 1
limit
integer
default:20

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

Required range: x >= 1
keyword
string

Keyword to filter annotations by question or answer content.

Response

200 - application/json

Successfully retrieved annotation list.

data
object[]

List of annotation items for the current page.

has_more
boolean

true if more pages are available beyond the current result set.

limit
integer

Number of items per page.

total
integer

Total number of annotations matching the query.

page
integer

Current page number.

Last modified on July 16, 2026