Skip to main content
GET
List campaign dispatches

Authorizations

Authorization
string
header
required

Developer key created from the dashboard (Settings → Developer Keys)

Path Parameters

id
string
required

The campaign to read dispatches for

Query Parameters

status
string

Filter by dispatch status, comma-separated (e.g. completed,failed). An unrecognized value returns 400 rather than silently matching nothing

updated_after
string

ISO 8601 timestamp with offset; returns only records updated after it. Encode + as %2B, or the offset is read as a space. For a daily pull, carry forward the largest updated_at from the previous run rather than using local midnight — post-call evaluation writes can land after the day rolls over

cursor
string

Pagination cursor. Echo back the previous page's next_cursor verbatim; its format is not part of the contract and may change

limit
integer

Records per page (1–5000, default 1000)

Required range: -9007199254740991 <= x <= 9007199254740991

Response

A page of dispatches

campaign_id
string
required
data
object[]
required
next_cursor
string | null
required

Pass as cursor to fetch the next page

has_more
boolean
required

Whether more records remain. Keep paging while this is true — never until a page looks full: responses are also bounded by size, so a page with large variables payloads is cut short of limit and reports has_more: true the same way