List outbound batch recipients
Lists a batch’s recipients in the order they were given, with status, attempts, next retry time, failure reason, the Conversation id once a call was placed, and that Conversation’s success evaluation (outcome) once post-call analysis ran. Filter by status; GET /conversations/ has the transcript and summary.
curl --request GET \
--url https://api.getarbol.com/v1/outbound-batches/{id}/recipients \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.getarbol.com/v1/outbound-batches/{id}/recipients', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.getarbol.com/v1/outbound-batches/{id}/recipients"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"attempts": 4503599627370495,
"conversationId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"createdAt": "2026-08-29T14:30:00Z",
"dynamicVariables": {},
"failureReason": "<string>",
"firstMessage": "<string>",
"fromChannelId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"name": "<string>",
"notBefore": "2026-08-29T14:30:00Z",
"phoneNumber": "+573001234567",
"prompt": "<string>",
"retryReason": "noAnswer",
"status": "pending",
"updatedAt": "2026-08-29T14:30:00Z",
"outcome": "success"
}
],
"nextCursor": "<string>"
}{
"defined": true,
"inferable": true,
"code": "BAD_REQUEST",
"status": 400,
"message": "<string>",
"data": {
"issues": [
{
"code": "custom",
"message": "<string>",
"path": [
"<string>"
]
}
],
"truncated": true
}
}{
"defined": true,
"inferable": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "<string>",
"data": "<unknown>"
}{
"defined": true,
"inferable": true,
"code": "FORBIDDEN",
"status": 403,
"message": "<string>",
"data": {
"missingPermissions": [
"agents:read"
]
}
}{
"defined": true,
"inferable": true,
"code": "NOT_FOUND",
"status": 404,
"message": "<string>",
"data": "<unknown>"
}{
"defined": true,
"inferable": true,
"code": "CONFLICT",
"status": 409,
"message": "<string>",
"data": "<unknown>"
}{
"defined": true,
"inferable": true,
"code": "SERVICE_UNAVAILABLE",
"status": 503,
"message": "<string>",
"data": "<unknown>"
}Authorizations
Organization-scoped Auth0 user access token issued to an approved first-party client or exchanged by a trusted OBO resource server.
Path Parameters
Opaque Arbol resource identifier; the endpoint and tenant-scoped lookup determine its resource type.
64^[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}$"agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31"
Query Parameters
Opaque forward-only cursor returned as nextCursor by the previous page. Never construct one by hand.
1 - 40961 <= x <= 1000pending: 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).
pending, calling, completed, failed, cancelled curl --request GET \
--url https://api.getarbol.com/v1/outbound-batches/{id}/recipients \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.getarbol.com/v1/outbound-batches/{id}/recipients', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.getarbol.com/v1/outbound-batches/{id}/recipients"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"attempts": 4503599627370495,
"conversationId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"createdAt": "2026-08-29T14:30:00Z",
"dynamicVariables": {},
"failureReason": "<string>",
"firstMessage": "<string>",
"fromChannelId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"name": "<string>",
"notBefore": "2026-08-29T14:30:00Z",
"phoneNumber": "+573001234567",
"prompt": "<string>",
"retryReason": "noAnswer",
"status": "pending",
"updatedAt": "2026-08-29T14:30:00Z",
"outcome": "success"
}
],
"nextCursor": "<string>"
}{
"defined": true,
"inferable": true,
"code": "BAD_REQUEST",
"status": 400,
"message": "<string>",
"data": {
"issues": [
{
"code": "custom",
"message": "<string>",
"path": [
"<string>"
]
}
],
"truncated": true
}
}{
"defined": true,
"inferable": true,
"code": "UNAUTHORIZED",
"status": 401,
"message": "<string>",
"data": "<unknown>"
}{
"defined": true,
"inferable": true,
"code": "FORBIDDEN",
"status": 403,
"message": "<string>",
"data": {
"missingPermissions": [
"agents:read"
]
}
}{
"defined": true,
"inferable": true,
"code": "NOT_FOUND",
"status": 404,
"message": "<string>",
"data": "<unknown>"
}{
"defined": true,
"inferable": true,
"code": "CONFLICT",
"status": 409,
"message": "<string>",
"data": "<unknown>"
}{
"defined": true,
"inferable": true,
"code": "SERVICE_UNAVAILABLE",
"status": 503,
"message": "<string>",
"data": "<unknown>"
}