List outbound batches
Lists the organization’s outbound batches, newest first, with recipient counts by status. Side-effect free.
GET
/
outbound-batches
List outbound batches
curl --request GET \
--url https://api.getarbol.com/v1/outbound-batches \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.getarbol.com/v1/outbound-batches', 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"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"agentId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"counts": {
"calling": 4503599627370495,
"cancelled": 4503599627370495,
"completed": 4503599627370495,
"failed": 4503599627370495,
"pending": 4503599627370495,
"total": 4503599627370495
},
"createdAt": "2026-08-29T14:30:00Z",
"endAt": "2026-08-29T14:30:00Z",
"firstMessage": "<string>",
"fromChannelId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"idempotencyKey": "<string>",
"name": "<string>",
"prompt": "<string>",
"retries": 2,
"retryDelaySeconds": 43230,
"retryOn": [
"noAnswer"
],
"schedule": {
"timezone": "America/Bogota",
"windows": [
{
"days": [
"mon"
],
"end": "09:30",
"start": "09:30"
}
]
},
"startAt": "2026-08-29T14:30:00Z",
"status": "queued",
"updatedAt": "2026-08-29T14:30:00Z"
}
],
"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
userOAuthmachineOAuth
Organization-scoped Auth0 user access token issued to an approved first-party client or exchanged by a trusted OBO resource server.
Query Parameters
Opaque forward-only cursor returned as nextCursor by the previous page. Never construct one by hand.
Required string length:
1 - 4096Required range:
1 <= x <= 100queued: 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 ⌘I
List outbound batches
curl --request GET \
--url https://api.getarbol.com/v1/outbound-batches \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.getarbol.com/v1/outbound-batches', 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"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"items": [
{
"agentId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"counts": {
"calling": 4503599627370495,
"cancelled": 4503599627370495,
"completed": 4503599627370495,
"failed": 4503599627370495,
"pending": 4503599627370495,
"total": 4503599627370495
},
"createdAt": "2026-08-29T14:30:00Z",
"endAt": "2026-08-29T14:30:00Z",
"firstMessage": "<string>",
"fromChannelId": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"id": "agt_018f47a2-4f4d-7d61-9e2c-1d7b8e9a0c31",
"idempotencyKey": "<string>",
"name": "<string>",
"prompt": "<string>",
"retries": 2,
"retryDelaySeconds": 43230,
"retryOn": [
"noAnswer"
],
"schedule": {
"timezone": "America/Bogota",
"windows": [
{
"days": [
"mon"
],
"end": "09:30",
"start": "09:30"
}
]
},
"startAt": "2026-08-29T14:30:00Z",
"status": "queued",
"updatedAt": "2026-08-29T14:30:00Z"
}
],
"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>"
}