Skip to main content
GET
/
batch-calls
List batch calls
curl --request GET \
  --url https://api.dialnexa.com/v1/batch-calls \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "batch_abc123",
      "name": "May Follow-Up Campaign",
      "status": "completed",
      "total_leads": 250,
      "completed": 235,
      "failed": 15,
      "agent_id": "agt_abc123",
      "created_at": "2024-03-01T10:00:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 150,
    "totalPages": 8
  }
}
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 this 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

ParameterDescription
pagePage number, starting from 1.
limitResults per page (max 100, default 20).
statusFilter by status (queued, processing, completed, failed, cancelled).

​
Errors

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

​
Request

curl "https://api.dialnexa.com/v1/batch-calls" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Response

{
  "data": [
    {
      "id": "bat_q1r5sv9mdk3z",
      "name": "May Follow-Up Run",
      "status": "completed",
      "total_calls": 250,
      "completed_calls": 250,
      "created_at": "2024-05-01T11:00:00.000Z"
    }
  ],
  "meta": { "page": 1, "limit": 20, "total": 1 }
}

Authorizations

​
Authorization
string
header
required

Pass your API key as a Bearer token in the Authorization header.

Query Parameters

​
page
integer
default:1
​
limit
integer
default:20

Response

200 - application/json

Success.

​
data
object[]
​
meta
object