List Batch Calls

GET List calls in a batch

GET /api/v1/public/call-batches/{batch_id}/calls

Retrieve a paginated list of all calls within a specific batch. Filter by status or external ID to find specific contacts.

Authorization

Authorization: Bearer sk_your_api_key

Path Parameters

Parameter	Type	Required	Description
batch_id	string	✅	The batch/schedule ID

Query Parameters

Parameter	Type	Required	Description
status	string	❌	Filter by call status: pending, completed, failed, etc.
external_id	string	❌	Filter by your contact's external/contact ID
limit	integer	❌	Results per page. Default: 100, Max: 500
page	integer	❌	Page number. Default: 1

Code Examples

cURL

curl -X GET "https://api.staging.techladder.ai/api/v1/public/call-batches/sched_bdb2b840/calls?status=pending&external_id=101&limit=100&page=1" \
  -H "Authorization: Bearer sk_your_api_key" \
  -H "Accept: application/json"

Python

import requests

batch_id = "sched_bdb2b840"

response = requests.get(
    f"https://api.staging.techladder.ai/api/v1/public/call-batches/{batch_id}/calls",
    headers={"Authorization": "Bearer sk_your_api_key"},
    params={
        "status": "pending",
        "external_id": "101",
        "limit": 100,
        "page": 1,
    },
)

print(response.json())

JavaScript

const batchId = "sched_bdb2b840";
const params = new URLSearchParams({
  status: "pending",
  external_id: "101",
  limit: "100",
  page: "1",
});

const response = await fetch(
  `https://api.staging.techladder.ai/api/v1/public/call-batches/${batchId}/calls?${params}`,
  {
    headers: { Authorization: "Bearer sk_your_api_key" },
  }
);

console.log(await response.json());

Java

import java.net.URI;
import java.net.http.*;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.staging.techladder.ai/api/v1/public/call-batches/sched_bdb2b840/calls?status=pending&external_id=101&limit=100&page=1"))
    .header("Authorization", "Bearer sk_your_api_key")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Responses

200 OK

A paginated list of calls within the batch.

{
  "status_code": 200,
  "message": "Batch calls fetched successfully",
  "error": null,
  "data": {
    "items": [
      {
        "call_id": "call_a1b2c3d4",
        "external_id": "101",
        "phone_number": "919876543210",
        "name": "John Doe",
        "status": "pending",
        "duration_seconds": null,
        "started_at": null,
        "ended_at": null,
        "metadata": {
          "Name": "John Doe",
          "Company Name": "Acme Corporation"
        }
      }
    ],
    "total": 1,
    "page": 1,
    "limit": 100,
    "has_more": false
  }
}

401 Unauthorized

Returned when the API key is missing or invalid.

{
  "status_code": 401,
  "message": "Missing or invalid API key",
  "error": {
    "code": "UNAUTHORIZED",
    "details": ["Provide a valid Bearer token in the Authorization header"]
  },
  "data": null
}

404 Not Found

Returned when the batch does not exist or is not owned by your account.

{
  "status_code": 404,
  "message": "Batch not found",
  "error": {
    "code": "NOT_FOUND",
    "details": ["No batch found with id sched_bdb2b840"]
  },
  "data": null
}

Call Status Values

Status	Description
pending	Call not yet initiated
queued	Call queued for dialing
ringing	Call is ringing
answered	Call was answered
in_progress	Call is active
completed	Call finished successfully
failed	Call failed (network/system error)
no_answer	Recipient did not answer
busy	Recipient line was busy
cancelled	Call was cancelled before connecting