> ## Documentation Index
> Fetch the complete documentation index at: https://dialnexa.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# List Workflow Leads
> List leads enrolled in a workflow.
Read only
**Recommended.** This endpoint is part of the public `/v1` API reference and is the supported path for new integrations. See the [migration guide](/docs/api-reference/v1/migrating-to-v1) for versioning guidance.
Returns leads enrolled in the given workflow. Each entry includes the signed lead `id`, the contact `phone_number`, dynamic variables from the uploaded file, the current `status`, and timestamps. 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](/docs/api-reference/v1/workflow-leads/history). For the call logs produced by enrolled leads, use [List Call Logs](/docs/api-reference/call-logs/list) filtered by the workflow ID.
## Path parameters
| Parameter | Description |
| ------------ | ------------------------------------------------ |
| `workflowId` | The workflow ID, for example `wfl_m3v7zb9rk2px`. |
## Query parameters
| Parameter | Description |
| --------- | ----------------------------------------------------------------------------------- |
| `leadIds` | Optional comma-separated lead IDs to filter, for example `lead_abc123,lead_def456`. |
## Errors
* `404 Not Found` is returned when the workflow does not exist.
## Related endpoints
* [Upload Workflow Leads](/docs/api-reference/v1/workflow-leads/add): upload leads from a CSV or Excel file.
* [Remove Workflow Lead](/docs/api-reference/v1/workflow-leads/delete): remove a lead from the workflow.
* [Lead History](/docs/api-reference/v1/workflow-leads/history): see every step a lead has moved through.
* [Get Variable Keys](/docs/api-reference/v1/workflow-leads/variable-keys): see which dynamic variables this workflow's leads can carry.
## OpenAPI
````yaml GET /v1/workflows/{workflowId}/leads
openapi: 3.0.0
info:
title: DialNexa API
description: >-
Public REST API for the DialNexa voice AI platform. Versioned endpoints are
under /v1; unversioned endpoints are legacy and deprecated.
version: 1.0.0
servers:
- url: https://api.dialnexa.com
description: DialNexa production API
security:
- bearer: []
tags:
- name: API Keys
- name: Agent Functions
- name: Agents V1
- name: Agents2
- name: Batch Calls
- name: Batch Calls V1
- name: Call Logs
- name: Calls
- name: Calls V1
- name: Campaign Leads
- name: Campaigns
- name: External Webhooks
- name: Knowledge Base
- name: Knowledge Base V1
- name: LLMs
- name: LLMs V1
- name: Languages
- name: Languages V1
- name: Organization Phone Numbers
- name: Organization Phone Numbers V1
- name: Phone Number Pricing
- name: Phone Number Pricing V1
- name: Transcribers
- name: Transcribers V1
- name: User Webhooks
- name: User Webhooks V1
- name: V1
- name: Voices
- name: Voices V1
- name: Webcall
- name: Workflow Leads
- name: Workflow Leads V1
- name: Workflows
- name: Workflows V1
paths:
/v1/workflows/{workflowId}/leads:
get:
tags:
- Workflow Leads V1
- V1
summary: List Workflow Leads
description: Returns leads enrolled in one workflow.
operationId: WorkflowLeadsV1Controller_findAll
parameters:
- name: workflowId
required: true
in: path
description: Workflow ID
schema:
type: string
example: workflow_abc123
- name: leadIds
required: false
in: query
description: Comma-separated lead IDs to filter
schema:
example: id1,id2
type: string
responses:
'200':
description: Leads returned successfully.
content:
application/json:
schema:
type: object
properties:
statusCode:
type: number
example: 200
message:
type: string
example: Leads fetched successfully
data:
type: array
items:
type: object
properties:
id:
type: string
example: lead_abc123
phone_number:
type: string
example: '+919876543210'
dynamic_variables:
type: object
example:
name: John
company: Acme
status:
type: string
example: pending
createdAt:
type: string
format: date-time
count:
type: number
example: 42
examples:
success:
summary: Successful response
value:
statusCode: 200
message: Leads fetched successfully
data:
- id: lead_abc123
phone_number: '+919876543210'
dynamic_variables:
customer_name: Priya Sharma
loan_amount: '500000'
status: pending
createdAt: '2026-07-03T10:30:00.000Z'
count: 1
'401':
description: Unauthorized - missing or invalid API key.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 401 Unauthorized
value:
statusCode: 401
message: API key is missing or invalid
error: Unauthorized
'403':
description: Forbidden - workflow does not belong to your organization.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 403 Forbidden
value:
statusCode: 403
message: You do not have permission to access this workflow
error: Forbidden
'404':
description: Workflow not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 404 Not Found
value:
statusCode: 404
message: Workflow not found
error: Not Found
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 500 Internal Server Error
value:
statusCode: 500
message: Internal server error
error: Internal Server Error
security:
- bearer: []
components:
schemas:
ErrorResponse:
type: object
properties:
statusCode:
type: integer
example: 400
message:
oneOf:
- type: string
- type: array
items:
type: string
example: phone_number must be a valid E.164 phone number
error:
type: string
example: Bad Request
required:
- statusCode
- message
- error
securitySchemes:
bearer:
scheme: bearer
bearerFormat: JWT
type: http
````