Skip to main content
GET
/
v1
/
broadcasts
List broadcasts
curl --request GET \
  --url https://api.zavu.dev/v1/broadcasts \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "brd_abc123",
      "name": "<string>",
      "status": "draft",
      "channel": "smart",
      "messageType": "text",
      "totalContacts": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "text": "<string>",
      "content": {
        "mediaUrl": "<string>",
        "mediaId": "<string>",
        "mimeType": "<string>",
        "filename": "<string>",
        "templateId": "<string>",
        "templateVariables": {}
      },
      "senderId": "<string>",
      "emailSubject": "<string>",
      "pendingCount": 123,
      "sendingCount": 123,
      "deliveredCount": 123,
      "failedCount": 123,
      "estimatedCost": 123,
      "reservedAmount": 123,
      "actualCost": 123,
      "scheduledAt": "2023-11-07T05:31:56Z",
      "startedAt": "2023-11-07T05:31:56Z",
      "completedAt": "2023-11-07T05:31:56Z",
      "metadata": {},
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "nextCursor": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

status
enum<string>

Current status of the broadcast.

Available options:
draft,
scheduled,
sending,
paused,
completed,
cancelled,
failed
limit
integer
default:50
Required range: x <= 100
cursor
string

Response

List of broadcasts.

items
object[]
required
nextCursor
string | null