Skip to main content
POST
List Flow Enrollment Candidates

Authorizations

X-API-Key
string
header
required

Body

application/json
flowPlanId
string
required

Existing reusable flow plan id.

status
enum<string> | null
default:awaiting

Candidate status: awaiting, processing, enrolled, skipped, or canceled. Defaults to awaiting; null lists all statuses.

Available options:
awaiting,
processing,
enrolled,
skipped,
canceled,
null
searchQuery
string | null

Optional search across contact name, email, phone, professional profile URL, company name, or domain.

limit
integer
default:20

Page size, from 1 to 100. Defaults to 20.

cursor
string | null

Cursor from the previous page, or omit for the first page.

Response

Tool result.

items
object[]
required
cursor
string | null
required
totalCount
integer
required