Skip to main content

List Call Batches

GET List all call batches

GET /api/v1/public/call-batches

Retrieve a paginated list of all call batches for your account. Filter by agent ID, status, or both.

Authorization

Authorization: Bearer sk_your_api_key

Query Parameters

ParameterTypeRequiredDescription
agent_idstringFilter by agent ID (e.g., agt-57949b14)
statusstringFilter by status: pending, active, completed, cancelled (active matches any in-flight state, e.g. queued, running, dispatching)
created_at_fromstringOnly return batches created at or after this ISO 8601 timestamp
created_at_tostringOnly return batches created at or before this ISO 8601 timestamp
limitintegerResults per page. Default: 50, Max: 200
pageintegerPage number (1-indexed). Default: 1

Code Examples

curl -X GET "https://api.techladder.ai/api/v1/public/call-batches?agent_id=agt-57949b14&status=pending&limit=50&page=1" \
-H "Authorization: Bearer sk_your_api_key" \
-H "Accept: application/json"

Responses

200 OK

A paginated list of call batches.

{
"status_code": 200,
"message": "Call batches fetched successfully",
"error": null,
"data": {
"items": [
{
"batch_id": "sched_7bac6f2a",
"agent_id": "agt-57949b14",
"version_id": "pmt-667ddf271b",
"status": "pending",
"total_contacts": 150,
"queued": 150,
"in_progress": 0,
"completed": 0,
"failed": 0,
"cancelled": 0,
"created_at": "2026-05-14T10:00:00Z"
}
],
"pagination": {
"page": 1,
"limit": 50,
"total": 1,
"has_more": false
}
}
}

401 Unauthorized

Returned when the API key is missing or invalid. This is not wrapped in the standard envelope.

{
"detail": "Invalid API key"
}

Batch Status Values

StatusDescription
pendingBatch created but not yet started
pausedBatch created in manual start mode, waiting to be started
queued / dispatching / runningBatch is currently dispatching or running calls
completedAll calls in the batch have finished
cancelledBatch was manually cancelled

Pass status=active to match any in-flight state (queued, running, dispatching, ringing, answered, in_progress, paused, pending) in one filter.