Get Workflow Lead History

GET

workflows

{workflowId}

leads

{id}

history

Get Lead Execution History

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

import requests

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

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

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

fetch('https://api.dialnexa.com/v1/workflows/{workflowId}/leads/{id}/history', 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/{id}/history",
  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/{id}/history"

	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/{id}/history")

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": "Lead history fetched successfully",
    "data": {
      "lead": {
        "id": "lead_abc123",
        "phone_number": "+919876543210",
        "dynamic_variables": [
          {
            "key": "customer_name",
            "value": "Priya Sharma"
          },
          {
            "key": "loan_amount",
            "value": "500000"
          }
        ],
        "notes": null
      },
      "execution": {
        "id": "Ex8nT4vQ1mLz6c",
        "current_node_id": "Wq3mK7pL9xNz2b",
        "status": "completed",
        "entry_time": "2026-07-03T10:31:00.000Z"
      },
      "history": [
        {
          "id": "Hs2kP9wQ4nLx7v",
          "from_node": null,
          "to_node": {
            "id": "Rt5vN8kQ2wLz7x",
            "label": "First call",
            "node_type": "VOICE_CALL",
            "config": {
              "phone_number_id": "phn_abc123"
            }
          },
          "transition_reason": "Entered workflow at entry node",
          "metadata": {},
          "transitioned_at": "2026-07-03T10:31:00.000Z"
        },
        {
          "id": "Hs5mR3tY8bKw1q",
          "from_node": {
            "id": "Rt5vN8kQ2wLz7x",
            "label": "First call",
            "node_type": "VOICE_CALL",
            "config": {
              "phone_number_id": "phn_abc123"
            }
          },
          "to_node": {
            "id": "Wq3mK7pL9xNz2b",
            "label": "Converted",
            "node_type": "CONVERTED",
            "config": {}
          },
          "transition_reason": "Call COMPLETED: completed",
          "metadata": {
            "call_id": "Cl7vB2nM5xQz9k",
            "call_status": "completed"
          },
          "transitioned_at": "2026-07-03T10:36:10.000Z"
        },
        {
          "id": "Hs8tW1nB6vQz3m",
          "from_node": {
            "id": "Wq3mK7pL9xNz2b",
            "label": "Converted",
            "node_type": "CONVERTED",
            "config": {}
          },
          "to_node": {
            "id": "Wq3mK7pL9xNz2b",
            "label": "Converted",
            "node_type": "CONVERTED",
            "config": {}
          },
          "transition_reason": "Reached CONVERTED terminal node",
          "metadata": {},
          "transitioned_at": "2026-07-03T10:36:10.000Z"
        }
      ],
      "all_nodes": [
        {
          "id": "Rt5vN8kQ2wLz7x",
          "label": "First call",
          "node_type": "VOICE_CALL",
          "config": {
            "phone_number_id": "phn_abc123",
            "phone_number_display": "+919876500000"
          },
          "position_x": 100,
          "position_y": 100
        },
        {
          "id": "Wq3mK7pL9xNz2b",
          "label": "Converted",
          "node_type": "CONVERTED",
          "config": {},
          "position_x": 400,
          "position_y": 100
        }
      ],
      "all_edges": [
        {
          "id": "Ed4jH6kL2mNp8r",
          "from_node_id": "Rt5vN8kQ2wLz7x",
          "to_node_id": "Wq3mK7pL9xNz2b",
          "label": "COMPLETED"
        }
      ]
    }
  },
  "timestamp": "2026-09-07T06:00:00.000Z"
}

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

{
  "statusCode": 404,
  "error": true,
  "success": false,
  "data": [],
  "message": "Lead Bv7nC2xKs5DqYw not found in workflow Hk3pW9zQe1LmRt",
  "errors": []
}

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

Read only Returns the history of a single lead’s path through the workflow, oldest transition first. Entries whose destination node has since been deleted are left out. Each history entry records one move between nodes: from_node (null for the first entry, or when that node has been deleted) and to_node (each with id, label, node_type and config), the transition_reason, transitioned_at, and metadata. When the lead left a VOICE_CALL node, metadata carries the matching call_id and call_status so you can pivot into Get Call Details to inspect the transcript. IDs inside the history (entry, node and call_id) are raw, without a prefix; Get Call Details accepts a raw call ID. The response also contains:

lead: the lead’s id (lead_...), phone_number, dynamic_variables (an array of key and value pairs) and notes.
execution: the lead’s current execution (id, current_node_id, status and entry_time), or null if the lead has not started. A lead stopped because its number is on the workspace’s DNC list has status dnc_blocked, and its last history entry has transition_reason Stopped: number is on the DNC list.
all_nodes and all_edges: every node and edge in the workflow, so you can draw the full graph around the lead’s path.

Use this endpoint for per-lead debugging, quality review, and rendering a timeline view in your dashboard. A removed lead’s history stays readable.

When to use this

Debugging a stuck lead: confirm which node the lead is waiting on (execution.current_node_id) and how long it has been there.
Quality review: produce a per-lead timeline for compliance or operations reviewers.
Drill-down from a dashboard: pivot from a workflow lead row into the full path the lead took.
Reporting on path coverage: sample lead histories to confirm conditional branches are being followed as expected.

For aggregate lead progress across the workflow, use List Workflow Leads. For the call record of a specific voice-call step, use the call_id returned by this endpoint with Get Call Details.

Path parameters

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

Errors

404 Not Found is returned when the workflow or lead does not exist, or the lead is not enrolled in the workflow.

List Workflow Leads: see every lead in the workflow.
Get Call Details: full transcript for the call_id returned above.
Get Workflow Details: workflow summary alongside per-lead drill-downs.
Call nodes: understand the voice-call steps referenced in the history.

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"

string

required

Lead ID

Example:

"lead_abc123"

Response

Lead execution history 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

Get Lead Execution History

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

import requests

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

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

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

fetch('https://api.dialnexa.com/v1/workflows/{workflowId}/leads/{id}/history', 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/{id}/history",
  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/{id}/history"

	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/{id}/history")

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": "Lead history fetched successfully",
    "data": {
      "lead": {
        "id": "lead_abc123",
        "phone_number": "+919876543210",
        "dynamic_variables": [
          {
            "key": "customer_name",
            "value": "Priya Sharma"
          },
          {
            "key": "loan_amount",
            "value": "500000"
          }
        ],
        "notes": null
      },
      "execution": {
        "id": "Ex8nT4vQ1mLz6c",
        "current_node_id": "Wq3mK7pL9xNz2b",
        "status": "completed",
        "entry_time": "2026-07-03T10:31:00.000Z"
      },
      "history": [
        {
          "id": "Hs2kP9wQ4nLx7v",
          "from_node": null,
          "to_node": {
            "id": "Rt5vN8kQ2wLz7x",
            "label": "First call",
            "node_type": "VOICE_CALL",
            "config": {
              "phone_number_id": "phn_abc123"
            }
          },
          "transition_reason": "Entered workflow at entry node",
          "metadata": {},
          "transitioned_at": "2026-07-03T10:31:00.000Z"
        },
        {
          "id": "Hs5mR3tY8bKw1q",
          "from_node": {
            "id": "Rt5vN8kQ2wLz7x",
            "label": "First call",
            "node_type": "VOICE_CALL",
            "config": {
              "phone_number_id": "phn_abc123"
            }
          },
          "to_node": {
            "id": "Wq3mK7pL9xNz2b",
            "label": "Converted",
            "node_type": "CONVERTED",
            "config": {}
          },
          "transition_reason": "Call COMPLETED: completed",
          "metadata": {
            "call_id": "Cl7vB2nM5xQz9k",
            "call_status": "completed"
          },
          "transitioned_at": "2026-07-03T10:36:10.000Z"
        },
        {
          "id": "Hs8tW1nB6vQz3m",
          "from_node": {
            "id": "Wq3mK7pL9xNz2b",
            "label": "Converted",
            "node_type": "CONVERTED",
            "config": {}
          },
          "to_node": {
            "id": "Wq3mK7pL9xNz2b",
            "label": "Converted",
            "node_type": "CONVERTED",
            "config": {}
          },
          "transition_reason": "Reached CONVERTED terminal node",
          "metadata": {},
          "transitioned_at": "2026-07-03T10:36:10.000Z"
        }
      ],
      "all_nodes": [
        {
          "id": "Rt5vN8kQ2wLz7x",
          "label": "First call",
          "node_type": "VOICE_CALL",
          "config": {
            "phone_number_id": "phn_abc123",
            "phone_number_display": "+919876500000"
          },
          "position_x": 100,
          "position_y": 100
        },
        {
          "id": "Wq3mK7pL9xNz2b",
          "label": "Converted",
          "node_type": "CONVERTED",
          "config": {},
          "position_x": 400,
          "position_y": 100
        }
      ],
      "all_edges": [
        {
          "id": "Ed4jH6kL2mNp8r",
          "from_node_id": "Rt5vN8kQ2wLz7x",
          "to_node_id": "Wq3mK7pL9xNz2b",
          "label": "COMPLETED"
        }
      ]
    }
  },
  "timestamp": "2026-09-07T06:00:00.000Z"
}

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

{
  "statusCode": 404,
  "error": true,
  "success": false,
  "data": [],
  "message": "Lead Bv7nC2xKs5DqYw not found in workflow Hk3pW9zQe1LmRt",
  "errors": []
}

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

Overview

Endpoints

When to use this

Path parameters

Errors

Authorizations

Path Parameters

Response

​When to use this

​Path parameters

​Errors

​Related endpoints

Authorizations

Path Parameters

Response

When to use this

Path parameters

Errors

Related endpoints