Batch Calls
List Batch Calls
List batch call jobs for your workspace and filter by draft, waiting, scheduled, running, paused, completed, cancelled, deleted, or compatibility active status.
GET
List Batch Calls
Read only
Returns every batch call job in your workspace, paginated and sorted by creation date with the newest first. API-key entries expose the available ID, title, status, total record count, originating number, creation time, and warning fields. 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
List Batch Calls response
The API-key response is a root JSON array. Pagination metadata and dashboard counters such asattempt_stages, picked_up_calls, and last_call_sent_at are not included. Request successive pages until a page contains fewer records than your requested limit.
Verify the result
Locate the expected batch ID and check itsstatus. For call-level evidence, use List Calls with batch_call_id.
Errors
403 Forbiddenis returned when the API key cannot read batch jobs on this workspace.
Related endpoints
- Get Batch Call: fetch a single batch’s detail.
- Create Batch Call: start a new batch.
- API pagination: how DialNexa list endpoints paginate.
- Batch calling: guidance on designing a batch.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Example:
20
Example:
1
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.