Skip to main content
GET
List a broadcast's recipients.

Authorizations

x-api-key
string
header
required

Your workspace API key. It both authenticates the caller and selects the workspace.

Path Parameters

broadcast
string<uuid>
required

Broadcast id.

Query Parameters

status
string

Filter by recipient delivery status: pending, sent, delivered, read, failed, skipped.

per_page
integer

Items per page (alias: limit). Default 25, max 100.

Response

A paginated list.

A paginated collection. per_page defaults to 25 and is capped at 100.

data
object[]
meta
object