Workflow Leads

List Workflow Leads

Returns the leads enrolled in one workflow, newest first, with each lead's latest execution status. An unknown workflow ID returns an empty list.

get/v1/workflows/{workflowId}/leads

Request

  • Base URL: https://api.dialnexa.com
  • URL: https://api.dialnexa.com/v1/workflows/{workflowId}/leads
  • Auth: HTTP bearer

Path parameters

workflowIdstring required
Example:workflow_abc123

Workflow ID

Query parameters

leadIdsstring
Example:lead_abc123,lead_def456

Comma-separated lead IDs to filter

Response

Leads returned successfully.

successtrue required
errorfalse required
statusCodeinteger required
messagestring required
timestampstring date-time required

Example response

{
  "statusCode": 200,
  "message": "Success",
  "data": {
    "statusCode": 200,
    "message": "Leads fetched successfully",
    "data": [
      {
        "id": "lead_abc123",
        "workflow_id": "Hk3pW9zQe1LmRt",
        "organization_id": "o14XKPP84rt22g",
        "phone_number": "+919876543210",
        "dynamic_variables": [
          {
            "key": "customer_name",
            "value": "Priya Sharma"
          }
        ],
        "status": "active"
      }
    ],
    "count": 42
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.