Skip to main content
GET
/
v1
/
voiceai
/
batch-calling
/
workspace
Get All Batch Calls For A Workspace
curl --request GET \
  --url https://api.example.com/v1/voiceai/batch-calling/workspace \
  --header 'x-api-key: <api-key>'
{
  "batch_calls": [
    {
      "id": "<string>",
      "name": "<string>",
      "agent_id": "<string>",
      "created_at_unix": 123,
      "scheduled_time_unix": 123,
      "last_updated_at_unix": 123,
      "status": "pending",
      "agent_name": "<string>",
      "phone_number_id": "<string>",
      "phone_provider": "twilio",
      "whatsapp_params": {
        "whatsapp_call_permission_request_template_name": "<string>",
        "whatsapp_call_permission_request_template_language_code": "<string>",
        "whatsapp_phone_number_id": "<string>"
      },
      "total_calls_dispatched": 0,
      "total_calls_scheduled": 0,
      "total_calls_finished": 0,
      "retry_count": 0
    }
  ],
  "next_doc": "<string>",
  "has_more": false
}

Authorizations

x-api-key
string
header
required

API key for programmatic access

Query Parameters

limit
integer
default:100

Maximum number of results

Required range: 1 <= x <= 500
last_doc
string | null

Cursor for pagination

Response

Successful Response

Response model for listing batch calls in a workspace.

batch_calls
BatchCallResponse · object[]
required

List of batch calls

next_doc
string | null

Cursor for next page of results

has_more
boolean
default:false

Whether there are more results