Skip to main content
GET
List a broadcast's recipients

Authorizations

Authorization
string
header
required

An org API key: Authorization: Bearer oak_….

Path Parameters

broadcast_id
string
required

Query Parameters

limit
integer
default:50
Required range: 1 <= x <= 200
cursor
string | null
status
enum<string> | null

Delivery status. Inbound lands received; outbound walks sending → sent → delivered → read (or → failed).

Available options:
received,
sending,
sent,
delivered,
read,
failed

Response

Successful Response

items
PublicBroadcastRecipient · object[]
required
next_cursor
string | null
required
total_count
integer | null