Skip to main content
GET
List Campaign Pipeline Automation Leads

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

campaign_id
string
required

Query Parameters

stage_id
string | null
step_id
string | null
automation_filter
enum<string>
default:ALL

Lead-list slices, expressed the way an operator asks for them.

Available options:
ALL,
ACTIVE,
COMPLETED,
EXITED,
NOT_ENROLLED,
PAUSED,
NEEDS_ATTENTION
search
string | null
page
integer
default:1
Required range: x >= 1
per_page
integer
default:25
Required range: 1 <= x <= 100

Response

Successful Response

data
CampaignAutomationLeadRow · object[]
required
total
integer
required