Workflow Leads
List Workflow Leads
List leads enrolled in a workflow.
GET
List Workflow Leads
Read only
Returns leads enrolled in the given workflow. Each entry includes the signed lead
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.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_idhas 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.
Path parameters
Query parameters
Errors
404 Not Foundis returned when the workflow does not exist.
Related endpoints
- Upload Workflow Leads: upload leads from a CSV or Excel file.
- Remove Workflow Lead: remove a lead from the workflow.
- Lead History: see every step a lead has moved through.
- Get Variable Keys: see which dynamic variables this workflow’s leads can carry.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Workflow ID
Example:
"workflow_abc123"
Query Parameters
Comma-separated lead IDs to filter
Example:
"id1,id2"
List Workflow Leads