Skip to main content
GET
List annotations

Authorizations

Authorization
string
header
required

API token for authentication

Query Parameters

workspace_id
string
required

The ID of the workspace

start
string<date-time>

Only annotations at or after this instant. Must be RFC3339; a malformed value is a 400 rather than a dropped filter.

end
string<date-time>

Only annotations at or before this instant. Must be RFC3339.

sources
string

Comma-separated list of sources to keep. Any value outside manual/broadcast is a 400.

limit
integer
default:100

Maximum rows to return. Values above the maximum are clamped to it rather than refused.

Required range: x <= 1000

Response

Annotations matching the filters

annotations
object[]