Skip to main content
GET
List Batch Calls
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 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

Errors

  • 403 Forbidden is returned when the API key cannot read batch jobs on this workspace.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
number
Example:

20

page
number
Example:

1

status
string

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.

Response

Batch calls returned successfully.

items
object[]
total
number
page
number
limit
number