Skip to main content
GET
List campaign recipients

Authorizations

Authorization
string
header
required

Send your team API key or project token as Authorization: Bearer <token>. The credential must have the required permissions. Project tokens can access only their own project.

Path Parameters

campaignId
string
required

Identifier for the campaign.

Query Parameters

projectId
string<uuid>

Project the campaign belongs to. Required with a team API key; a project token is bound to its own project and omits it.

Value constraints

status
enum<string>

Current status of this resource or operation.

Allowed values

Available options:
queued,
sending,
sent,
delivered,
read,
failed,
skipped
cursor
string

Specifies cursor for this query parameter.

Value constraints

Required string length: 1 - 256
limit
integer
default:25

Specifies limit for this query parameter.

Value constraints

Required range: 1 <= x <= 100

Response

Success

data
object[]
required

Structured data carried by this object.

page
object
required

Specifies page for this schema.