Skip to main content
GET
Preview campaign recipients

Authorizations

Authorization
string
header
required

API key authentication. Use "Bearer <api_key>" or "Api-Key <api_key>".

Path Parameters

uuid
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

recipient_scope
enum<string>
Available options:
candidate
limit
integer
default:25
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: 0 <= x <= 9007199254740991
Maximum string length: 200

Response

200 - application/json

Default Response

mode
enum<string>
required
Available options:
preview
total
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
suppressed
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
active
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
campaign_status
enum<string> | null
required
Available options:
draft,
scheduled,
sending,
sent,
partial,
failed,
cancelled
recipients
object[]
required