Skip to main content
GET
List events
Returns a paginated list of events. Filter by program_id, status, event_type, participant_id, external_id, or rule_id. Use from / to to scope by ingestion time (created_at), and event_from / event_to to scope by occurrence time (event_timestamp). Both pairs can be combined. Results are sorted by created_at descending by default. Set sort_by=event_timestamp to sort by when events occurred rather than when they were received. Each event includes its processing status (PENDING, PROCESSING, COMPLETED, FAILED) and event_type (EXTERNAL for API-ingested events, SYSTEM for internally generated ones like scheduled events).
For usage patterns and examples, see the Event Processing guide.

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Query Parameters

limit
integer
default:50

Maximum number of results (default 50, max 200)

Required range: x >= 1
cursor
string

Pagination cursor from previous response

program_id
string<uuid>

Filter by program ID

status
enum<string>

Filter by event status

Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
event_type
enum<string>

Filter by event type

Available options:
EXTERNAL,
SYSTEM
participant_id
string<uuid>

Filter by participant ID

external_id
string

Filter by external ID

from
string<date-time>

Start of time window (RFC 3339) — filters on system ingestion time

to
string<date-time>

End of time window (RFC 3339) — filters on system ingestion time

event_from
string<date-time>

Start of event occurrence window (RFC 3339) — filters on event_timestamp

event_to
string<date-time>

End of event occurrence window (RFC 3339) — filters on event_timestamp

sort_by
enum<string>

Sort field

Available options:
created_at,
event_timestamp,
status
rule_id
string<uuid>

Filter by rule ID (events where rule matched)

sort_dir
enum<string>

Sort direction: asc or desc (default)

Available options:
asc,
desc

Response

List of events with payloads

data
object[]

Data contains the list of items

pagination
object

Pagination contains cursor information for fetching more results