Skip to main content
GET
List events

Authorizations

Authorization
string
header
required

Organization API key, sent as Authorization: Bearer boom_org_....

Query Parameters

name
string

Filter by exact event name.

Minimum string length: 1
personExternalId
string

Filter to events whose subject is this person externalId.

Minimum string length: 1
customObjectType
string

Filter by custom-object type name.

Minimum string length: 1
customObjectExternalId
string

Filter by custom-object externalId.

Minimum string length: 1
start
string

Inclusive lower bound on event timestamp, ISO 8601.

end
string

Inclusive upper bound on event timestamp, ISO 8601.

limit
integer

Max items to return, 1-1000 (default 100).

Required range: 1 <= x <= 1000
cursor
string

Opaque pagination token from a previous response's next_cursor. Omit for the first page.

Response

Success

data
object[]
required
next_cursor
string | null
required