Skip to content

List Org Events

GET
/events

List the organisation’s events, newest first, with cursor pagination.

Covers every event the EDA pipeline stores for the org plus website tracking rows. Filters combine with AND. Pages are stable under concurrent writes: the cursor encodes the last (timestamp, uid) seen.

Authorizations

Parameters

Query Parameters

type
Any of:
Array<string>

Filter by event type (repeatable), e.g. sequencer, inbox, voiceai.

name
Any of:
Array<string>

Filter by event name (repeatable), e.g. sequence_email_replied.

source
Any of:
string
<= 200 characters

Filter by producing service.

contact_id
Any of:
string
<= 200 characters

Only events whose message.contact_id matches.

sequence_id
Any of:
string
<= 200 characters

Only events whose message.sequence_id matches.

campaign_id
Any of:
string
<= 200 characters

Only events whose message.campaign_id matches.

since
Any of:
string format: date-time

Window start (ISO 8601). Defaults to 7 days before until.

until
Any of:
string format: date-time

Window end, exclusive (ISO 8601). Defaults to now.

cursor
Any of:
string
<= 512 characters

next_cursor from the previous page.

limit

Page size.

integer
default: 50 >= 1 <= 200

Page size.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

A page of events, newest first.

object
events
Array<object>

One event from the org’s event store.

object
actor_email
Any of:
string
campaign_id
Any of:
string
contact_id
Any of:
string
id
Any of:
string
message

The event payload exactly as produced.

object
key
additional properties
any
name
Any of:
string
occurred_at
Any of:
string
sequence_id
Any of:
string
source
Any of:
string
type
Any of:
string
url
Any of:
string
has_more

Whether another page exists within the requested window.

boolean
next_cursor
Any of:
string
since
required

Lower bound of the window that was searched (ISO 8601, UTC).

string
until
required

Upper bound of the window that was searched (ISO 8601, UTC).

string
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string