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 /v1/batch-calls

List Batch Calls

cURL

curl --request GET \
  --url https://api.dialnexa.com/v1/batch-calls \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "id": "batch_abc123",
      "title": "Q3 Follow-up Batch",
      "status": "waiting",
      "total_records": 250,
      "createdAt": "2026-07-03T10:30:00.000Z",
      "total_lead_count": 250,
      "sent_lead_count": 240,
      "picked_up_lead_count": 120,
      "picked_up_calls": 116,
      "last_call_sent_at": "2026-07-03T11:42:18.000Z",
      "number_of_retries": 2,
      "first_retry_count": 80,
      "second_retry_count": 25,
      "third_retry_count": 0,
      "fourth_retry_count": 0,
      "attempt_stages": [
        {
          "depth": 0,
          "attempted": 240,
          "total": 250
        },
        {
          "depth": 1,
          "attempted": 60,
          "total": 80
        },
        {
          "depth": 2,
          "attempted": 10,
          "total": 25
        }
      ]
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 20
}

Read only Returns every batch call job in your workspace, paginated and sorted by creation date with the newest first. Each entry includes the batch title, current status, recipient and attempt counters, completed call rollups, latest dispatch time, and 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 compatibility active.

Response Counters

Field	Meaning
attempt_stages	Per-stage attempted and total counts. Depth 0 is the initial call, and depths 1 through 4 are retries.
picked_up_calls	Completed call attempts across initial calls and retry children. In-progress and unanswered attempts are excluded.
picked_up_lead_count	Legacy connected-recipient counter retained for compatibility. Prefer picked_up_calls for the current Picked Up value.
last_call_sent_at	Latest dispatch timestamp across initial calls and retry children.

Verify The Result

Confirm that items belongs to the authenticated workspace, then compare picked_up_calls and attempt_stages with campaign-linked Call History rows when exact recipient evidence matters.

Errors

• 403 Forbidden is 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.
• Pagination: how DialNexa list endpoints paginate.
• Batch calling: guidance on designing a batch.

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

200

application/json

Batch calls returned successfully.

items · object[]

Show child attributes

total · number

page · number

limit · number