Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Query Parameters

cadenceStep
integer
required

Saved cadence step index.

Required range: x >= 0
page
integer

Page number.

Required range: x >= 1
limit
integer

Page size. Maximum 100.

Required range: 1 <= x <= 100

Case-insensitive lead search.

locationId
string

Limit results to one project location id. The caller must have access to the project.

campaignId
string

Limit results to one campaign id.

campaignIds
string

Comma-separated campaign ids for combined campaign views.

cadenceId
string

Optional schedule id used to scope the roster to a single cadence.

Response

Paginated cadence-step leads.

success
boolean
required
data
object
required