List batch calls

List every batch call in the workspace with its status and counters.

GEThttps://api.tried.com.au/list-batch-calls

Returns all batch calls in the workspace, newest first. Use it to show progress across batches. Tasks are not included; read them with Get batch call.

Request#

This endpoint takes no path, query or body parameters.

Example request#

curl https://api.tried.com.au/list-batch-calls \
  -H "Authorization: Bearer $TRIED_API_KEY"

const res = await fetch("https://api.tried.com.au/list-batch-calls", {
  headers: { Authorization: `Bearer ${process.env.TRIED_API_KEY}` },
});
const batches = await res.json();

import os, requests

res = requests.get(
    "https://api.tried.com.au/list-batch-calls",
    headers={"Authorization": f"Bearer {os.environ['TRIED_API_KEY']}"},
)
batches = res.json()

Response#

200 OK

An array of batch call objects, ordered by creation time, newest first. The list is not paginated.

[
  {
    "batch_call_id": "batch_call_5f2a9c1e7b3d4a6f8e0b1c2d",
    "name": "Appointment reminders",
    "from_number": "+61291234567",
    "scheduled_timestamp": 1760850000000,
    "status": "ongoing",
    "total_task_count": 250,
    "sent": 120,
    "picked_up": 84,
    "successful": 61,
    "reserved_concurrency": 2,
    "call_time_window": {
      "windows": [{ "start": 540, "end": 1020 }],
      "timezone": "Australia/Sydney"
    }
  },
  {
    "batch_call_id": "batch_call_a1b2c3d4e5f60718293a4b5c",
    "name": "Renewal follow-up",
    "from_number": "+14155550123",
    "scheduled_timestamp": 1760763600000,
    "status": "sent",
    "total_task_count": 40,
    "sent": 40,
    "picked_up": 29,
    "successful": 22,
    "reserved_concurrency": 0,
    "call_time_window": null
  }
]

Field	Type	Description
`status`	string	`draft`, `planned`, `ongoing`, `sent` or `stopped`.
`sent`	integer	Tasks dialled so far.
`picked_up`	integer	Batch calls that connected.
`successful`	integer	Batch calls whose post-call analysis marked `call_successful` true.

The other fields are described in Create batch call.

Errors#

Status	When
`401`	Missing or invalid API key.
`403`	The key's IP allowlist or scopes reject the request. This route needs the `calls` scope.
`429`	Rate limit exceeded. See Rate limits.

See Errors for the body format.

Retell compatibility#

Retell's API reference documents only Create batch call. This endpoint is a Tried addition.