Skip to main content
GET
List Events

Authorizations

Authorization
string
header
required

Bearer API key issued from Settings → Developers.

Query Parameters

page
integer
default:1

Page number.

Required range: x >= 1
size
integer
default:10

Number of items per page.

Required range: 1 <= x <= 100
sort_by
enum<string> | null

Field to sort by.

Available options:
occurred_at
sort_order
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
event_name
string | null

Filter by event name.

resolution_status
enum<string> | null

Filter by resolution status.

Available options:
PENDING,
RESOLVED,
UNRESOLVED
external_event_id
string | null

Filter by external event id.

occurred_at_after
string<date-time> | null

Return events strictly after this timestamp (exclusive).

occurred_at_before
string<date-time> | null

Return events strictly before this timestamp (exclusive).

Response

200 - application/json

Successful Response

items
PublicEventOutput · object[]
required

Records on this page.

total_count
integer
required

Total number of records matching the query.

total_pages
integer
required

Total number of pages.

has_more
boolean
required

Whether more pages remain after the current one.