List batches

cURL

curl --request GET 'https://api.brightalk.ai/batches?limit=20' \
  --header "Authorization: Bearer $BRIGHTALK_API_KEY" \
  --header "Brightalk-Version: 2026-07-16"

const response = await fetch("https://api.brightalk.ai/batches?limit=20", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.BRIGHTALK_API_KEY}`,
    "Brightalk-Version": "2026-07-16",
  },
});
console.log(response.status, await response.json());

import os
import requests

response = requests.request(
    "GET",
    "https://api.brightalk.ai/batches?limit=20",
    headers={
    "Authorization": f"Bearer {os.environ['BRIGHTALK_API_KEY']}",
    "Brightalk-Version": "2026-07-16",
    },
)
print(response.status_code, response.json())

{
  "data": [
    {
      "id": "bat_demo_001",
      "name": "Renewal reminders",
      "agent_id": "agt_demo_001",
      "total_recipients": 2,
      "pending_recipients": 2,
      "queued_recipients": 0,
      "in_progress_recipients": 0,
      "completed_recipients": 0,
      "failed_recipients": 0,
      "cancelled_recipients": 0,
      "answered_recipients": 0,
      "no_answer_recipients": 0,
      "busy_recipients": 0,
      "created_at": "2026-07-20T01:00:00Z",
      "updated_at": "2026-07-20T01:00:00Z",
      "scheduled_start_at": "2026-07-20T01:00:00Z",
      "calling_window": {
        "time_zone": "Asia/Taipei",
        "weekdays": [
          "monday",
          "tuesday",
          "wednesday",
          "thursday",
          "friday"
        ],
        "start_time": "09:00",
        "end_time": "18:00"
      },
      "started_at": "2026-07-20T01:00:00Z",
      "paused_at": "2026-07-20T01:00:00Z",
      "completed_at": "2026-07-20T01:00:00Z",
      "cancelled_at": "2026-07-20T01:00:00Z"
    }
  ],
  "next_cursor": "<string>"
}

GET

batches

cURL

curl --request GET 'https://api.brightalk.ai/batches?limit=20' \
  --header "Authorization: Bearer $BRIGHTALK_API_KEY" \
  --header "Brightalk-Version: 2026-07-16"

const response = await fetch("https://api.brightalk.ai/batches?limit=20", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.BRIGHTALK_API_KEY}`,
    "Brightalk-Version": "2026-07-16",
  },
});
console.log(response.status, await response.json());

import os
import requests

response = requests.request(
    "GET",
    "https://api.brightalk.ai/batches?limit=20",
    headers={
    "Authorization": f"Bearer {os.environ['BRIGHTALK_API_KEY']}",
    "Brightalk-Version": "2026-07-16",
    },
)
print(response.status_code, response.json())

{
  "data": [
    {
      "id": "bat_demo_001",
      "name": "Renewal reminders",
      "agent_id": "agt_demo_001",
      "total_recipients": 2,
      "pending_recipients": 2,
      "queued_recipients": 0,
      "in_progress_recipients": 0,
      "completed_recipients": 0,
      "failed_recipients": 0,
      "cancelled_recipients": 0,
      "answered_recipients": 0,
      "no_answer_recipients": 0,
      "busy_recipients": 0,
      "created_at": "2026-07-20T01:00:00Z",
      "updated_at": "2026-07-20T01:00:00Z",
      "scheduled_start_at": "2026-07-20T01:00:00Z",
      "calling_window": {
        "time_zone": "Asia/Taipei",
        "weekdays": [
          "monday",
          "tuesday",
          "wednesday",
          "thursday",
          "friday"
        ],
        "start_time": "09:00",
        "end_time": "18:00"
      },
      "started_at": "2026-07-20T01:00:00Z",
      "paused_at": "2026-07-20T01:00:00Z",
      "completed_at": "2026-07-20T01:00:00Z",
      "cancelled_at": "2026-07-20T01:00:00Z"
    }
  ],
  "next_cursor": "<string>"
}

Authorizations

Authorization

string

header

required

Use a private-beta server credential in the Authorization header.

Headers

Brightalk-Version

string

default:2026-07-16

Selects the date-based API version. Omission uses the organization’s pinned private-beta default.

Allowed value: "2026-07-16"

X-Request-Id

string

A caller-generated correlation value matching [A-Za-z0-9._:-]{1,64}. Invalid values are replaced.

Maximum string length: 64

Pattern: ^[A-Za-z0-9._:-]{1,64}$

Query Parameters

limit

integer

default:20

Number of resources to return. Defaults to 20 and is capped at 100.

Required range: 1 <= x <= 100

cursor

string

An opaque cursor returned by the previous page.

Required string length: 1 - 2048

status

enum<string>

Available options:

draft,

scheduled,

queued,

in_progress,

paused,

completed,

failed,

cancelled

created_after

string<date-time>

created_before

string<date-time>

Response

Batches returned.

data

object[]

required

Show child attributes

next_cursor

string | null

required

Cancel a call Create a draft batch

⌘I

Get started

API fundamentals

Core concepts

Guides

Release information

API Reference

Authorizations

Headers

Query Parameters

Response