Skip to main content
GET
Get a batch

Authorizations

Authorization
string
header
required

A long-lived, privileged API key (ek_... prefix), minted once from the dashboard. Intended for trusted server-side use only; never expose it in client-side code. Send as Authorization: Bearer ek_.... Required by every Calls, Batches, Agents, Tools, MCP Servers, Documents, and Realtime route.

Path Parameters

batch_id
string
required

Query Parameters

limit
integer
default:100
offset
integer
default:0

Response

Successful Response

batch_id
string
required
agent_id
string
required
name
string
required
status
string
required
total
integer
required
completed_count
integer
required
failed_count
integer
required
voicemail_count
integer
required
in_progress_count
integer
required
created_at
string<date-time>
required
recipients
V1BatchRecipientStatus · object[]
required
recipients_total
integer
required
has_more
boolean
required
provider
string | null
scheduled_at
string<date-time> | null