Skip to main content
GET
List campaign leads

Authorizations

X-API-Key
string
header
required

API key with format cs_live_xxx

Path Parameters

campaign_id
string<uuid>
required

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
limit
integer
default:20

Items per page

Required range: 1 <= x <= 100
status_filter
string | null

Filter by status

search
string | null

Search by email or name

batch_id
string<uuid> | null

Filter by batch ID

Response

Leads retrieved successfully

Response for listing campaign leads.

success
boolean
required
message
string
required
leads
LeadResponse · object[]
required

List of leads

pagination
PaginationMeta · object
required

Pagination information