Skip to main content
GET
Get Campaign Leads
Leads are sorted by creation date (newest first), returned as createdAt: the date the lead was added to the campaign. Page through them with limit and offset. Use the state query parameter to filter leads by their current state (e.g., scanned, contacted, interested).

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

campaignId
string
required

The unique identifier of the campaign

Query Parameters

state
string

Filter leads by state (e.g., scanned, contacted, interested, notInterested, etc.)

limit
integer
default:100

Maximum number of leads to return. Default: 100, Max: 500

Required range: 1 <= x <= 500
offset
integer
default:0

Number of leads to skip, for paging past the first page. Default: 0

Required range: x >= 0

Response

200 - application/json

List of leads in the campaign

_id
string

Unique lead identifier

contactId
string

Associated contact identifier

state
string

Current lead state

createdAt
string<date-time>

When the lead was added to the campaign (the sort key, newest first)