Automations · Broadcasts
Returns broadcasts, one page at a time.
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the messages resource group disabled get 403 resource_group_disabled. Authentication
Query parameters
| Name | Type | Notes |
|---|---|---|
profileId | string | |
status | string | One of draft, scheduled, sending, completed, failed, cancelled |
platform | string | |
limit | integer | Default 50 |
skip | integer | Default 0 |
Example
curl -X GET "https://api.pozy.ai/v1/broadcasts?limit=50" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/broadcasts?limit=50", {
headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);import os
import requests
resp = requests.get(
"https://api.pozy.ai/v1/broadcasts",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
params={
"limit": 50,
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
successbooleanbroadcastsarray of object17 child fields
idstringnamestringdescriptionstringplatformstringaccountIdstringaccountNamestringstatusstringOne of
draft,scheduled,sending,completed,failed,cancelled.messagePreviewstringscheduledAtstring (date-time)startedAtstring (date-time)completedAtstring (date-time)recipientCountintegersentCountintegerdeliveredCountintegerreadCountintegerfailedCountintegercreatedAtstring (date-time)
paginationobjecttotalintegerlimitintegerskipintegerhasMoreboolean
200 response
{
"success": true,
"broadcasts": [
{
"id": "6bfebd43ddc270f6d2c56fc5",
"name": "Acme",
"description": "A short description",
"platform": "instagram",
"accountId": "696e0b682d0a31188e7a2ba9",
"accountName": "Acme",
"status": "draft",
"messagePreview": "Hello from Pozy",
"scheduledAt": "2026-10-02T09:00:00.000Z",
"startedAt": "2026-10-02T09:00:00.000Z",
"completedAt": "2026-10-02T09:00:00.000Z",
"recipientCount": 42,
"sentCount": 42,
"deliveredCount": 42,
"readCount": 42,
"failedCount": 42,
"createdAt": "2026-10-02T09:00:00.000Z"
}
],
"pagination": {
"total": 42,
"limit": 1,
"skip": 1,
"hasMore": true
}
}Errors
Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:
| 400 | invalid_request_error | A parameter or body field is missing or invalid. param names it. |
| 401 | authentication_error | The API key is missing, revoked or expired. |
| 403 | permission_error | The key is scoped to other profiles or has this resource group disabled. |
| 429 | rate_limit_error | Too many requests this minute. Wait for Retry-After seconds. |
Every code is listed in Errors.