Skip to main content
GET
List Workflow Leads
Read only
Recommended. This endpoint is part of the public /v1 API reference and is the supported path for new integrations. See the migration guide for versioning guidance.
Returns leads enrolled in the given workflow. Each entry includes the signed lead id, the contact phone_number, dynamic variables from the uploaded file, the current status, and timestamps. Use this to monitor live progress through the sequence, build operational dashboards, and detect leads that need review.

When to use this

  • Workflow dashboards: render an enrollment table with each lead’s current step.
  • Stall detection: find leads whose current_node_id has not changed in the expected time window and flag them for review.
  • Compliance audits: enumerate enrolled leads to demonstrate which contacts were dialled in a given period.
  • CRM sync: write back the per-lead status to the originating CRM record.
For a single lead’s full step-by-step history, use Lead History. For the call logs produced by enrolled leads, use List Call Logs filtered by the workflow ID.

Path parameters

Query parameters

Errors

  • 404 Not Found is returned when the workflow does not exist.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workflowId
string
required

Workflow ID

Example:

"workflow_abc123"

Query Parameters

leadIds
string

Comma-separated lead IDs to filter

Example:

"id1,id2"

Response

Leads returned successfully.

statusCode
number
Example:

200

message
string
Example:

"Leads fetched successfully"

data
object[]
count
number
Example:

42