List Workflow Leads - DialNexa Documentation

GET

workflows

{workflowId}

leads

Get all leads for a specific workflow

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

import requests

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

headers = {
    "x-organization-id": "<x-organization-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.dialnexa.com/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/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>",
    "x-organization-id: <x-organization-id>"
  ],
]);

$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/workflows/{workflowId}/leads"

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

	req.Header.Add("x-organization-id", "<x-organization-id>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.dialnexa.com/workflows/{workflowId}/leads")
  .header("x-organization-id", "<x-organization-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

Legacy endpoint - deprecated. Unversioned endpoints are scheduled for removal on July 31, 2026. Use the /v1 version for new integrations. This endpoint remains available for existing integrations until then.

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

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

Query parameters

Parameter	Description
`page`	Page number, starting from 1.
`limit`	Results per page (max 100, default 20).
`status`	Filter to leads in a specific status.

Errors

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

Upload Workflow Leads: enroll a new lead.
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.

Headers

x-organization-id

string

required

RSA encrypted organization ID (base64 format)

Example:

"BASE64_ENCRYPTED_ORG_ID_HERE"

Path Parameters

workflowId

string

required

Query Parameters

leadIds

string

required

Response

List of leads

Remove Workflow LeadRemove a single lead from an active workflow without stopping the workflow itself.

Get all leads for a specific workflow

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

import requests

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

headers = {
    "x-organization-id": "<x-organization-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://api.dialnexa.com/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/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>",
    "x-organization-id: <x-organization-id>"
  ],
]);

$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/workflows/{workflowId}/leads"

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

	req.Header.Add("x-organization-id", "<x-organization-id>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.dialnexa.com/workflows/{workflowId}/leads")
  .header("x-organization-id", "<x-organization-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

​When to use this

​Path parameters

​Query parameters

​Errors

​Related endpoints

Authorizations

Headers

Path Parameters

Query Parameters

Response

When to use this

Path parameters

Query parameters

Errors

Related endpoints