List broadcasts

Search Documentation

Search across all developer documentation

broadcasts

List broadcasts

GET /v1/broadcasts
Auth required api.broadcasts.view

Returns the org's broadcasts, newest-first. A broadcast is a one-time, point-in-time bulk send of a template version (or inline HTML) to a List or Segment, with consent enforced at send. Create and send are available under api.broadcasts.manage (POST /v1/broadcasts and POST /v1/broadcasts/{id}/send); edit, reschedule, and cancel remain dashboard-only. Cursors are opaque base64; stale or malformed cursors silently fall back to page 1.

A broadcast sent without an opt-out topic degrades its unsubscribe link to an account-wide opt-out (unsubscribe_all) — recipients can only leave every send, not one stream. Prefer sending with a topic; the dashboard requires acknowledging this before a topic-less send.

Query parameters

limit integer optional

Page size (1–200). Default 50.

cursor string optional

Opaque cursor returned from the previous page.

tag array optional

Filter to entities carrying a tag with this full path name (repeatable; union/OR across values — the Gmail default). Pass untagged=true instead to return only entities with no tags. Applied before pagination.

Responses

200 Cursor-paginated list of broadcasts, newest-first application/json
401 Missing, malformed, or unknown API key application/problem+json
403 Key lacks the required scope or plan limit violated application/problem+json
422 Query parameter or path value failed validation application/problem+json
429 Per-org rate limit exceeded application/problem+json
500 Unexpected server-side failure. The code is internal_error. The request_id field can be quoted to SendOps support to investigate. application/problem+json