Skip to main content
GET
List Batches

Headers

string
required
Your API key for authentication.

Query Parameters

string
Retrieve only batches with a specific campaign ID.
integer
The starting index (inclusive) for the range of batches to retrieve.
integer
The ending index for the range of batches to retrieve.
integer
The maximum number of batches to return in the response.
boolean
Whether to sort the batches in ascending order of their creation time.

Response

string
Can be success or error.
array
Contains an array of batch objects.
string
The unique identifier for the batch.
string
The original base prompt used to create the batch. Will still contain the original placeholder variables such as business or name.
string
The label you assigned to the batch (if any).
string
Enterprise customers with custom endpoints will see the endpoint code here (if specified).
array
The base call parameters used to create the batch, such as voice_id, max_duration, reduce_latency, and wait_for_greeting.
string
The date and time the batch was created.