Skip to main content
GET
List outbound batch recipients

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.

Path Parameters

id
string
required

Opaque Arbol resource identifier; the endpoint and tenant-scoped lookup determine its resource type.

Maximum string length: 64
Pattern: ^[a-z][a-z0-9]{1,15}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
Example:

"agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31"

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:100
Required range: 1 <= x <= 1000
status
enum<string>

pending: waiting for a free slot, or for notBefore after a no-answer retry. calling: the provider accepted the call; stays until the Conversation closes and its post-call evaluation is in. completed: the call counted as successful (evaluation success, or unknown when the Agent has no assessments). failed: no answer or evaluation failure after every retry, or the provider rejected the call; see failureReason. cancelled: dropped by a batch cancel or by reaching endAt (failureReason expired).

Available options:
pending,
calling,
completed,
failed,
cancelled

Response

OK

items
Outbound batch recipient with result · object[]
required
Maximum array length: 1000
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