Skip to main content
GET
List Batch Calls

Headers

string
required
API key used for authenticating requests to the API.
string
required
Workspace identifier for the API.

Path Parameters

string
required
The unique identifier of the batch call operation

Query Parameters

number
default:"1"
Page number for pagination (1-based)
number
default:"20"
Number of results per page (maximum 100)
string
default:"all"
Filter calls by status
  • all - Return all calls regardless of status
  • waiting - Only calls waiting in queue
  • active - Only calls currently in progress
  • completed - Only successfully completed calls
  • failed - Only failed calls

Response

array
Array of call objects in the batch
object
Pagination information
object
Summary statistics for the batch

Example Usage

Example Response

Error Responses

string
Error message describing what went wrong
Common Error Codes:
  • 500 - Server error retrieving batch calls

Use Cases

  • Build dashboards showing all calls in a batch
  • Filter and review failed calls for troubleshooting
  • Export call results for reporting and analysis
  • Monitor active calls in real-time