Skip to main content
GET
List annotations

Authorizations

Authorization
string
header
required

Use an Observe API key from the management console. The key selects the project and must grant the permission listed on the operation. Keep this key on your server.

Query Parameters

fromMs
integer<int64>

Only return annotations with dateMs greater than or equal to this value (epoch ms).

toMs
integer<int64>

Only return annotations with dateMs less than or equal to this value (epoch ms).

orderBy
enum<string>
default:created

Field to order by

Available options:
created,
date
orderDirection
enum<string>
default:desc

Order direction

Available options:
asc,
desc
page
integer
default:1

The page number to retrieve for paginated results.

Example:

1

pageSize
integer
default:10

The number of items to return per page. Useful for pagination.

Example:

20

Response

Paginated list of annotations. Paging metadata is returned in X-Corbado-Page, X-Corbado-TotalPages, and X-Corbado-TotalItems response headers.

Maximum array length: 1000
id
string
required

Annotation ID (format ann-<number>).

headline
string
required

Short headline describing the annotation.

dateMs
integer<int64>
required

The annotated point in time in milliseconds since epoch.

createdMs
integer<int64>
required

Creation time in milliseconds since epoch.

updatedMs
integer<int64>
required

Last update time in milliseconds since epoch.

description
string

Optional longer description of the annotation.