Skip to main content
GET
Get campaign recipients

Headers

x-api-key
string
required

API key needed to authorize the request

Path Parameters

campaignId
string<uuid>
required

The ID of the campaign, from List campaigns

Query Parameters

page
integer
default:1
Required range: x >= 1
page_size
integer
default:50
Required range: 1 <= x <= 100

Response

Campaign recipients retrieved successfully.

total
integer

Total matching items

page
integer
page_size
integer
has_more
boolean

Whether another page exists after this one

steps
object[]
recipients
object[]