Skip to main content
GET
List Campaign Leads

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

campaign_id
string<uuid>
required

Query Parameters

status
enum<string> | null

Campaign lead status values.

SKIPPED is a new terminal status introduced by the commonality threshold filter (plan 2026-05-21-commonality-threshold-filter, AC-19). Dispatcher selection (status IN ('active', 'connected')) already naturally excludes it. The DB CHECK constraint expansion lives in PR-2a.

Available options:
pending,
preview,
active,
processing,
completed,
replied,
bounced,
unsubscribed,
failed,
paused,
invalid,
skipped,
waiting_acceptance,
connected,
connection_ignored,
rate_limited
page
integer
default:1

Page number

Required range: x >= 1
page_size
integer
default:50

Items per page

Required range: 1 <= x <= 200
email_gateway
string | null

Corporate email gateway segment: 'any' for every lead whose email domain is behind a secure email gateway (these leads are not emailed), or one gateway such as 'mimecast'.

Pattern: ^[a-z0-9_]{1,40}$

Response

Successful Response

Response model for campaign lead list.

leads
CampaignLeadResponse · object[]
required

List of leads

total
integer
required

Total number of leads

page
integer
required

Current page number

page_size
integer
required

Items per page