Skip to main content
GET
/
workflows
/
{workflowId}
/
leads
List workflow leads
curl --request GET \
  --url https://api.dialnexa.com/v1/workflows/{workflowId}/leads \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "wflead_abc",
      "workflow_id": "wf_abc123",
      "phone_number": "+919876543210",
      "current_node_id": "node_abc",
      "status": "active",
      "created_at": "2024-03-01T10:00:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8
  }
}
Returns every lead enrolled in the given workflow, paginated. Each entry includes the lead’s enrollment id, the contact phone_number, the current status (pending, in_progress, completed, removed, failed), the current_node_id the lead is sitting on, and the enrolled_at timestamp. Use this to monitor live progress through the sequence, build operational dashboards, and detect leads that have stalled on a specific node.

​
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

ParameterDescription
workflowIdThe workflow ID, for example wfl_m3v7zb9rk2px.

​
Query parameters

ParameterDescription
pagePage number, starting from 1.
limitResults per page (max 100, default 20).
statusFilter to leads in a specific status.

​
Errors

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

​
Request

curl "https://api.dialnexa.com/v1/workflows/wfl_m3v7zb9rk2px/leads" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response

{
  "data": [
    {
      "id": "wlead_p3q8zv5bk2mx",
      "phone_number": "+919876543210",
      "status": "in_progress",
      "current_node_id": "node_t2n6bw4pq9rz",
      "enrolled_at": "2024-05-01T09:00:00.000Z"
    },
    {
      "id": "wlead_n7r2wk4vb9pz",
      "phone_number": "+919123456789",
      "status": "completed",
      "current_node_id": null,
      "enrolled_at": "2024-05-01T09:01:00.000Z"
    }
  ],
  "meta": { "page": 1, "limit": 20, "total": 420 }
}

Authorizations

​
Authorization
string
header
required

Pass your API key as a Bearer token in the Authorization header.

Path Parameters

​
workflowId
string
required

Query Parameters

​
page
integer
default:1
​
limit
integer
default:20

Response

200 - application/json

Success.

​
data
object[]
​
meta
object