Skip to content
Esc
↑↓navigate↵open⌘Jpreview

List broadcasts

Newest first, with cursor pagination: after takes the last id of a page and pages toward older items, before takes the first id and pages back toward newer ones.

GET/broadcasts
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Query parameters
limitinteger

Page size, 1-100 (default 20)

min 1 · max 100
afterstring<uuid>

Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.

beforestring<uuid>

Cursor: id of the first item of the current page; returns the previous page; same rule as after.

Responses
200

Broadcasts

objectstringrequired
Allowed:list
dataobject[]required
Show properties
Array of object
idstring<uuid>required
namestring | nullrequired
segment_idstring<uuid> | nullrequired
statusstringrequired

draft, queued, sent, or the BillionSend extensions canceled and failed. failed: the send could not go ahead, either on a condition no retry would change or because the retries ran out; failure_reason says why. Emails already handed off stay sent.

created_atstringrequired
scheduled_atstring | nullrequired
sent_atstring | nullrequired
failure_reasonstring | nullrequired

BillionSend extension: why a failed broadcast failed (domain_missing: its sending domain was deleted; sender_domain_mismatch: from is no longer on that domain; topic_other_domain / segment_other_domain: its topic or segment is bound to another domain; domain_unverified: its sending domain was not verified through every retry; retries_exhausted: sending kept failing until the retries ran out); null unless status is failed

Allowed:domain_missingsender_domain_mismatchtopic_other_domainsegment_other_domaindomain_unverifiedretries_exhaustednull
failed_atstring | nullrequired

BillionSend extension: when the broadcast failed; null unless status is failed

sent_countinteger | nullrequired

Emails handed off so far; null before the send starts and once its emails have left the retention window

finishes_atstring | nullrequired

Estimated instant the last email goes out, while the broadcast is going out; else null

has_morebooleanrequired
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
422

Validation error

statusCodenumberrequired
namestringrequired
messagestringrequired
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.billionsend.com/broadcasts' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "object": "list",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "segment_id": "0dbbf761-5b2d-4647-8bfa-2b714456749c",
      "status": "string",
      "created_at": "string",
      "scheduled_at": "string",
      "sent_at": "string",
      "failure_reason": "domain_missing",
      "failed_at": "string",
      "sent_count": 0,
      "finishes_at": "string"
    }
  ],
  "has_more": true
}

Was this page helpful?