> ## 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 Batch Calls
> List batch call jobs for your workspace and filter by draft, waiting, scheduled, running, paused, completed, cancelled, deleted, or legacy active status.
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 every batch call job in your workspace, paginated and sorted by creation date (newest first). Each entry includes the batch's display `name`, the current `status`, the totals of attempted and completed calls, and the creation timestamp. Use List Batch Calls to power a batch history dashboard, build automation that watches for new batches, or audit which jobs have run in a given period.
## When to use this
* **Operational dashboards**: render a batch history view with progress bars.
* **Compliance audits**: list every batch run in a quarter for review.
* **Reporting pipelines**: sync batch metadata into a data warehouse alongside call logs.
* **Automation triggers**: detect newly created batches and start downstream reporting jobs.
## Query parameters
| Parameter | Description |
| --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `page` | Page number, starting from 1. |
| `limit` | Results per page (max 100, default 20). |
| `status` | Filter by one batch status or comma-separated statuses. Supported values include `draft`, `waiting`, `scheduled`, `running`, `paused`, `completed`, `cancelled`, `deleted`, and legacy `active`. |
## Errors
* `403 Forbidden` is returned when the API key cannot read batch jobs on this workspace.
## Related endpoints
* [Get Batch Call](/docs/api-reference/v1/batches/get): fetch a single batch's detail.
* [Create Batch Call](/docs/api-reference/v1/batches/create): start a new batch.
* [Pagination](/docs/api-reference/pagination): how DialNexa list endpoints paginate.
* [Batch calling](/docs/batch-calls/overview): guidance on designing a batch.
## OpenAPI
````yaml GET /v1/batch-calls
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/batch-calls:
get:
tags:
- Batch Calls
- Batch Calls V1
- V1
summary: List Batch Calls
description: >-
Returns batch call jobs for the authenticated workspace, including
status and progress fields.
operationId: BatchCallsV1Controller_list
parameters:
- name: limit
required: false
in: query
schema:
example: 20
type: number
- name: page
required: false
in: query
schema:
type: number
example: 1
- name: status
required: false
in: query
description: >-
Filter by batch status - can be a single status or comma-separated
list. Supported values include draft, waiting, scheduled, running,
paused, completed, cancelled, deleted, and legacy active.
schema:
type: string
responses:
'200':
description: Batch calls returned successfully.
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
type: object
properties:
id:
type: string
example: batch_abc123
title:
type: string
status:
type: string
total_records:
type: number
createdAt:
type: string
format: date-time
total:
type: number
page:
type: number
limit:
type: number
examples:
success:
summary: Successful response
value:
items:
- id: batch_abc123
title: Q3 Follow-up Batch
status: waiting
total_records: 250
createdAt: '2026-07-03T10:30:00.000Z'
total: 1
page: 1
limit: 20
'400':
description: Invalid query parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 400 Bad Request
value:
statusCode: 400
message: Invalid query parameters
error: Bad Request
'401':
description: Unauthorized.
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.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 403 Forbidden
value:
statusCode: 403
message: >-
Destination country or network prefix is not enabled for
this workspace
error: Forbidden
'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
````