Skip to main content
GET
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Path Parameters

id
string
required

The broadcast's prefixed id (e.g. bcst_abc123).

Query Parameters

starting_after
string

Cursor for pagination — the ID of the last item in the previous page

limit
integer
default:20

Items per page

Required range: 1 <= x <= 100
status
enum<string>

Only return recipients in this delivery state.

Available options:
queued,
sent,
delivered,
bounced,
complained,
failed

Response

Broadcast recipients

object
enum<string>
required
Available options:
list
data
object[]
required
has_more
boolean
required
url
string