List Workflow Leads

GET

workflows

{workflowId}

leads

List Workflow Leads

curl --request GET \
  --url https://api.dialnexa.com/v1/workflows/{workflowId}/leads \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dialnexa.com/v1/workflows/{workflowId}/leads', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dialnexa.com/v1/workflows/{workflowId}/leads",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dialnexa.com/v1/workflows/{workflowId}/leads"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/v1/workflows/{workflowId}/leads")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "error": false,
  "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"
          },
          {
            "key": "loan_amount",
            "value": "500000"
          }
        ],
        "notes": null,
        "tags": [
          "priority"
        ],
        "is_deleted": false,
        "status": "active",
        "current_node_id": "Rt5vN8kQ2wLz7x",
        "entry_time": "2026-07-03T10:31:00.000Z",
        "completed_at": null,
        "createdAt": "2026-07-03T10:30:00.000Z",
        "updatedAt": "2026-07-03T10:30:00.000Z",
        "created_at": "2026-07-03T10:30:00.000Z",
        "updated_at": "2026-07-03T10:30:00.000Z"
      }
    ],
    "count": 1
  },
  "timestamp": "2026-09-07T06:00:00.000Z"
}

{
  "statusCode": 401,
  "error": true,
  "success": false,
  "data": [],
  "message": "Invalid API key",
  "errors": []
}

{
  "statusCode": 500,
  "error": true,
  "success": false,
  "data": [],
  "message": "Error fetching workflow leads: Internal server error",
  "errors": []
}

Read only Returns the leads enrolled in the given workflow, newest first, in data.data, with their number in data.count. Each entry includes the signed lead id, the contact phone_number as written in the uploaded file, dynamic_variables (an array of key and value pairs, one per non-empty data cell; blank cells add no entry), notes, tags, the raw workflow_id, and timestamps, plus the lead’s latest execution:

status: pending (not started yet), active, completed, dropped, failed, or dnc_blocked (stopped because the number is on the workspace’s DNC list).
current_node_id, entry_time and completed_at: null while the lead is pending.

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. To review calls produced by enrolled leads in the dashboard, use Call History.

Path parameters

Parameter	Description
`workflowId`	The workflow ID, for example `workflow_m3v7zb9rk2px4q`.

Query parameters

Parameter	Description
`leadIds`	Optional comma-separated lead IDs to filter, for example `lead_abc123,lead_def456`.

Errors

An unknown workflow ID is not an error: the response is 200 with an empty list.
401 Unauthorized is returned when the API key is missing or invalid.

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

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:

"lead_abc123,lead_def456"

Response

Leads returned successfully.

success

enum<boolean>

required

Available options:

true

error

enum<boolean>

required

Available options:

false

statusCode

integer

required

Example:

200

message

string

required

Example:

"Success"

data

object

required

Show child attributes

timestamp

string<date-time>

required

List Workflow Leads

curl --request GET \
  --url https://api.dialnexa.com/v1/workflows/{workflowId}/leads \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dialnexa.com/v1/workflows/{workflowId}/leads', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dialnexa.com/v1/workflows/{workflowId}/leads",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dialnexa.com/v1/workflows/{workflowId}/leads"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.dialnexa.com/v1/workflows/{workflowId}/leads")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "success": true,
  "error": false,
  "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"
          },
          {
            "key": "loan_amount",
            "value": "500000"
          }
        ],
        "notes": null,
        "tags": [
          "priority"
        ],
        "is_deleted": false,
        "status": "active",
        "current_node_id": "Rt5vN8kQ2wLz7x",
        "entry_time": "2026-07-03T10:31:00.000Z",
        "completed_at": null,
        "createdAt": "2026-07-03T10:30:00.000Z",
        "updatedAt": "2026-07-03T10:30:00.000Z",
        "created_at": "2026-07-03T10:30:00.000Z",
        "updated_at": "2026-07-03T10:30:00.000Z"
      }
    ],
    "count": 1
  },
  "timestamp": "2026-09-07T06:00:00.000Z"
}

{
  "statusCode": 401,
  "error": true,
  "success": false,
  "data": [],
  "message": "Invalid API key",
  "errors": []
}

{
  "statusCode": 500,
  "error": true,
  "success": false,
  "data": [],
  "message": "Error fetching workflow leads: Internal server error",
  "errors": []
}

Overview

Endpoints

When to use this

Path parameters

Query parameters

Errors

Authorizations

Path Parameters

Query Parameters

Response

​When to use this

​Path parameters

​Query parameters

​Errors

​Related endpoints

Authorizations

Path Parameters

Query Parameters

Response

When to use this

Path parameters

Query parameters

Errors

Related endpoints