DialNexa Workflow Leads API
The Workflow Leads API from DialNexa — 4 operation(s) for workflow leads.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/dialnexa-workflow-leads-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: DialNexa Workflow Leads API
description: Public `/v1` REST API for the DialNexa voice AI platform.
version: 1.0.0
servers:
- url: https://api.dialnexa.com
description: DialNexa production API
security:
- bearer: []
tags:
- name: Workflow Leads
paths:
/v1/workflows/{workflowId}/leads:
post:
operationId: uploadWorkflowLeads
parameters:
- name: workflowId
required: true
in: path
description: Workflow ID
schema:
example: workflow_abc123
type: string
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
description: CSV or Excel file with leads data
examples:
request:
summary: Upload workflow leads file
value:
file: workflow-leads.csv
responses:
'201':
description: File processed successfully.
content:
application/json:
examples:
success:
summary: Successful response
value:
statusCode: 201
message: Leads uploaded successfully
data:
'+919876543210':
- lead_abc123
count: 1
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 400 Bad Request
value:
statusCode: 400
message: File must be a CSV or Excel file (.csv, .xlsx, .xls)
error: Bad Request
'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
'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
'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
security:
- bearer: []
summary: Upload Workflow Leads
tags:
- Workflow Leads
description: Uploads and enrolls leads in one workflow from a supported file.
get:
operationId: listWorkflowLeads
parameters:
- name: workflowId
required: true
in: path
description: Workflow ID
schema:
example: workflow_abc123
type: string
- 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
'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
'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
security:
- bearer: []
summary: List Workflow Leads
tags:
- Workflow Leads
description: Returns leads enrolled in one workflow.
/v1/workflows/{workflowId}/leads/variable-keys:
get:
operationId: listWorkflowLeadVariableKeys
parameters:
- name: workflowId
required: true
in: path
description: Workflow ID
schema:
example: workflow_abc123
type: string
responses:
'200':
description: Variable keys returned successfully.
content:
application/json:
examples:
success:
summary: Successful response
value:
statusCode: 200
message: Variable keys fetched successfully
data:
keys:
- customer_name
- loan_amount
- product
'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
'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
'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
security:
- bearer: []
summary: Get Workflow Lead Variables
tags:
- Workflow Leads
description: Returns dynamic variable keys discovered across leads in one workflow.
/v1/workflows/{workflowId}/leads/{id}:
delete:
operationId: deleteWorkflowLead
parameters:
- name: workflowId
required: true
in: path
description: Workflow ID
schema:
example: workflow_abc123
type: string
- name: id
required: true
in: path
description: Lead ID
schema:
example: lead_abc123
type: string
responses:
'200':
description: Lead removed successfully.
content:
application/json:
examples:
success:
summary: Successful response
value:
statusCode: 200
message: Lead removed successfully
'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
'404':
description: Lead not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 404 Not Found
value:
statusCode: 404
message: Workflow lead 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
'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
security:
- bearer: []
summary: Delete Workflow Lead
tags:
- Workflow Leads
description: Removes one lead from a workflow and prevents it from advancing to later steps.
/v1/workflows/{workflowId}/leads/{id}/history:
get:
operationId: getWorkflowLeadHistory
parameters:
- name: workflowId
required: true
in: path
description: Workflow ID
schema:
example: workflow_abc123
type: string
- name: id
required: true
in: path
description: Lead ID
schema:
example: lead_abc123
type: string
responses:
'200':
description: Lead execution history returned successfully.
content:
application/json:
examples:
success:
summary: Successful response
value:
statusCode: 200
message: Lead history fetched successfully
data:
lead:
id: lead_abc123
phone_number: '+919876543210'
dynamic_variables:
customer_name: Priya Sharma
loan_amount: '500000'
status: pending
createdAt: '2026-07-03T10:30:00.000Z'
history:
- node_id: node_start
node_type: VOICE_CALL
label: Initial call
status: completed
call_id: call_abc123
started_at: '2026-07-03T10:30:00.000Z'
ended_at: '2026-07-03T10:32:00.000Z'
'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
'404':
description: Lead not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 404 Not Found
value:
statusCode: 404
message: Workflow lead 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
'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
security:
- bearer: []
summary: Get Lead Execution History
tags:
- Workflow Leads
description: Returns node-by-node execution history for one workflow lead.
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
type: http