Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Use GET /api/v1/broadcasts to list all broadcasts in your ChatbotX workspace, including scheduling details and contact reach counts.
/api/v1/broadcasts1 or greater. Defaults to 1.1 or greater.curl --request GET \
--url 'https://app.chatbotx.io/api/v1/broadcasts?page=1&perPage=20' \
--header 'Authorization: Bearer <token>'
import requests
url = "https://app.chatbotx.io/api/v1/broadcasts"
params = {"page": 1, "perPage": 20}
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, params=params, headers=headers)
print(response.json())
const options = {
method: 'GET',
headers: { Authorization: 'Bearer <token>' }
};
fetch('https://app.chatbotx.io/api/v1/broadcasts?page=1&perPage=20', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
200 OK with a data array of broadcast objects.
Show data item fields
null if no flow is linked.scheduled, sending, or sent.{
"data": [
{
"id": "brd_001",
"name": "Black Friday Sale",
"schedulesAt": "2024-11-29T08:00:00Z",
"contactCount": 5240,
"flowId": "301",
"status": "scheduled"
},
{
"id": "brd_002",
"name": "Product Update Announcement",
"schedulesAt": "2024-10-15T10:00:00Z",
"contactCount": 12800,
"flowId": null,
"status": "sent"
}
]
}