Sign in

v1

latestOpenAPI 3.0.32026-07-26737274.2 KB
Broadcasts

List broadcasts

Returns a cursor-paginated list of broadcasts in the account with their content, targeting (subscriber_filter), email template, and web-publishing settings. Filter by lifecycle status (draft, scheduled, sending, completed, aborted) and by the sent_after/sent_before timestamps. Default 500 results per page, maximum 1000.

Tip: set slim=true to omit the expensive fields (content, public_url, email_address, email_template, subscriber_filter) for a faster, smaller response — useful when you only need identifiers and subjects.

Delivery and engagement stats are not included in this response; use Get stats for a list of broadcasts for those. Broadcasts that are also published as posts share a publication_id with the matching post from List posts.

get/v4/broadcasts

Query parameters

{"stackTrail":"paths:/v4/broadcasts:get:parameters:0:schema","oasType":"schema","type":"unknown","nullable":true}

To fetch next page of results, use ?after=<end_cursor>

{"stackTrail":"paths:/v4/broadcasts:get:parameters:1:schema","oasType":"schema","type":"unknown","nullable":true}

To fetch previous page of results, use ?before=<start_cursor>

include_total_countboolean

Set to true to include the total_count in the response. This option can cause slow responses; if paging through results, request it only on the first page and reuse the value for subsequent pages.

{"stackTrail":"paths:/v4/broadcasts:get:parameters:3:schema","oasType":"schema","type":"unknown","nullable":true}

Number of results per page. Default 500, maximum 1000.

{"stackTrail":"paths:/v4/broadcasts:get:parameters:4:schema","oasType":"schema","type":"unknown","nullable":true}

Get broadcasts sent after this date (format yyyy-mm-dd).

{"stackTrail":"paths:/v4/broadcasts:get:parameters:5:schema","oasType":"schema","type":"unknown","nullable":true}

Get broadcasts sent before this date (format yyyy-mm-dd).

slimboolean

When true, omits expensive optional fields from the response. Produces a faster, smaller response — useful when extra fields are not needed.

status'draft' | 'scheduled' | 'sending' | 'completed' | 'aborted'

Filter broadcasts by lifecycle status. One of: draft, scheduled, sending, completed, aborted.

Response

Returns a paginated list of all broadcasts for your account (including draft, scheduled, and already sent)