Skip to main content
GET
List outbound batches

Authorizations

Authorization
string
header
required

Organization-scoped Auth0 user access token issued to an approved first-party client or exchanged by a trusted OBO resource server.

Query Parameters

cursor
string

Opaque forward-only cursor returned as nextCursor by the previous page. Never construct one by hand.

Required string length: 1 - 4096
limit
integer
default:20
Required range: 1 <= x <= 100
status
enum<string>

queued: no call placed yet. running: at least one call placed. completed: every recipient settled. cancelled: pending recipients were dropped; calls already placed finish normally.

Available options:
queued,
running,
completed,
cancelled

Response

OK

items
Outbound batch · object[]
required
Maximum array length: 100
nextCursor
string | null
required

Opaque forward-only cursor returned as nextCursor by the previous page. Never construct one by hand.

Required string length: 1 - 4096