Get a Broadcast by ID or Name via the ChatbotX API

Use this endpoint to fetch the complete details of a specific broadcast. You can identify the broadcast by either its numeric ID or its exact name. The response includes status, scheduling type, scheduled time, contact count, and the associated flow ID.

GET /api/v1/broadcasts/{idOrName}

Path Parameters

string

required

The unique ID or exact name of the broadcast to retrieve.

Code Examples

curl --request GET \
  --url 'https://app.chatbotx.io/api/v1/broadcasts/brd_001' \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.chatbotx.io/api/v1/broadcasts/brd_001"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)
print(response.json())

const options = {
  method: 'GET',
  headers: { Authorization: 'Bearer <token>' }
};

fetch('https://app.chatbotx.io/api/v1/broadcasts/brd_001', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

Response

Returns 200 OK with a single broadcast object.

Response Fields

string

required

The unique identifier of the broadcast.

string

required

The display name of the broadcast.

string

required

The current status of the broadcast. One of scheduled, sending, or sent.

string

required

Whether the broadcast was sent immediately or at a future time. One of now or future.

string

required

ISO 8601 timestamp indicating when the broadcast is scheduled to send.

integer | null

required

The number of contacts targeted by this broadcast, or null if not yet calculated.

string | null

The ID of the automation flow linked to this broadcast, or null if no flow is linked.

Example Response

{
  "id": "brd_001",
  "name": "Black Friday Sale",
  "status": "scheduled",
  "schedulesType": "future",
  "schedulesAt": "2024-11-29T08:00:00Z",
  "contactCount": 5240,
  "flowId": "301"
}

⌘I

Overview

Contacts

Custom Fields

Tags

Flows & Sequences

Broadcasts & Channels

Workspace

AI Agents

Get a Broadcast by ID or Name via the ChatbotX API

Path Parameters

Code Examples

Response

Response Fields

Example Response

​Path Parameters

​Code Examples

​Response

​Response Fields

​Example Response

Path Parameters

Code Examples

Response

Response Fields

Example Response