broadcasts
List broadcasts
Returns broadcasts with delivery stats. Filter by status, platform, or profile.
AuthorizationBearer <token>
API key authentication - use your Zernio API key as a Bearer token
In: header
Query Parameters
profileId?string
Filter by profile. Omit to list across all profiles
status?string
Value in
"draft" | "scheduled" | "sending" | "completed" | "failed" | "cancelled"platform?string
limit?integer
Default
50skip?integer
Default
0Response Body
application/json
application/json
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.broadcasts.listBroadcasts();console.log(data);{
"success": true,
"broadcasts": [
{
"id": "string",
"name": "string",
"description": "string",
"platform": "string",
"accountId": "string",
"accountName": "string",
"status": "draft",
"messagePreview": "string",
"scheduledAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"completedAt": "2019-08-24T14:15:22Z",
"recipientCount": 0,
"sentCount": 0,
"deliveredCount": 0,
"readCount": 0,
"failedCount": 0,
"createdAt": "2019-08-24T14:15:22Z"
}
],
"pagination": {
"total": 0,
"limit": 0,
"skip": 0,
"hasMore": true
}
}{
"error": "Unauthorized"
}