HomeSandbox AccountsAPIApp StudioWebhooksCommunity
API
Start typing to search…

Get broadcast recipients

get
https://{yourAccountName}.api-us1.com/api/3/sms/broadcasts//recipients

Fetch all contacts who were sent a specific broadcast

Path Params
integer
required

Broadcast ID

Query Params
date

Start date (YYYY-MM-DD)

date

End date (YYYY-MM-DD)

filters[deliverability][]
array of strings

Filter by deliverability status

filters[deliverability][]
filters[engagement][]
array of strings

Filter by engagement type

filters[engagement][]
string

Search contacts by name or phone

string
enum

Order by field

Allowed:
integer
Defaults to 0

Offset for pagination

integer
Defaults to 20

Number of items to return

Response

Updated 4 months ago

Language
Credentials
Header
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 4 months ago