Skip to main content
GET

​
Overview

Fetch detailed information for a single batch, including campaign metadata, status, and a paginated list of call records. This endpoint supports advanced filtering, sorting, and searching to help you analyze call data. Use it for monitoring execution from the dashboard or building custom analytics.

​
Prerequisites

  • Bearer token for an authenticated user who owns the batch.
  • The batch id you obtained during creation.

​
Request

​
string
required
Bearer token for the authenticated user.
​
string
required
Batch identifier you want to inspect.
​
integer
default:"1"
Page number for paginated calls.
​
integer
default:"10"
Maximum call records to return per page (default: 10).
​
string
JSON stringified filter object to filter calls by specific fields. Example: {"callStatus":"completed"}.
​
string
Field to sort by (e.g., “createdAt”).
​
string
default:"asc"
Sort order: “asc” for ascending or “desc” for descending.
​
string
Search term to filter calls across dynamic fields (e.g., customer name, phone number).

​
Response

​
object
required
Contains batch metadata and paginated call records.
​
string
required
The batch identifier.
​
string
required
The name of the batch.
​
string
required
Current status of the batch (e.g., “active”, “completed”, “paused”).
​
integer
required
Current page number.
​
integer
required
Number of records per page.
​
integer
required
Total number of calls in the batch matching the filter criteria.
​
integer
required
Total number of pages available.
​
array[object]
required
Array of call records with enriched data including phone logs, recording URLs, and transcripts when available.

​
Error Handling

  • 400 Bad Request – Invalid batch ID format, invalid filter JSON, or query parameters out of range.
  • 404 Not Found – Batch not found or does not belong to the authenticated user.
  • 500 Internal Server Error – Failed to aggregate batch data; retry or contact support.
Advanced Features:
  • Filtering: Use the filter parameter with JSON to filter calls by specific fields from the phone logs
  • Sorting: Sort by any field using sortBy and control order with sortOrder
  • Searching: The search parameter performs a regex search across all dynamic string fields in call records
  • Phone logs are automatically included with each call record when available
For real-time monitoring, combine this endpoint with webhooks to track batch progress. Use filtering and sorting to identify specific call outcomes or issues.

Authorizations

​
Authorization
string
header
required

Bearer token authentication for workspace access

Path Parameters

​
id
string
required

Query Parameters

​
page
integer
default:1
​
limit
integer
default:10
​
filter
string
​
sortBy
string
​
sortOrder
enum<string>
default:asc
Available options:
asc,
desc
​
search
string

Response

Batch details fetched successfully