ACactivecampaign
Recipients
Broadcasts

Get broadcast recipients

Fetch all contacts who were sent a specific broadcast

get/sms/broadcasts/{broadcastId}/recipients

Request

  • Base URL
    https://yourAccountName.api-us1.com/api/3
  • URL
    https://yourAccountName.api-us1.com/api/3/sms/broadcasts/{broadcastId}/recipients
  • Auth
    API key in header Api-Token

Path parameters

broadcastIdinteger required

Broadcast ID

Query parameters

start_datestring date

Start date (YYYY-MM-DD)

end_datestring date

End date (YYYY-MM-DD)

filters[deliverability][]string[]

Filter by deliverability status

filters[engagement][]string[]

Filter by engagement type

searchstring

Search contacts by name or phone

order[field]'name' | 'phone' | 'sentDate' | 'clicks' | 'deliverability' | 'optOut' | 'replies'

Order by field

offsetinteger

Offset for pagination

limitinteger

Number of items to return

Response

Recipients retrieved successfully

Changes

No recorded changes to this operation across all 1 revision of this API.