Read a broadcast and its progress
Build a request to copy
This page never sends a request. Fill in the fields, then copy the request and run it from your server.
curl -X GET 'https://api.whatsable.app/v1/broadcasts/string'
bearerAuthAuthorizationBearer <nfy_live_<32 characters>>An API key from Settings > API keys, sent as Authorization: Bearer <key>.
id*stringThe broadcast id.
1 <= length <= 64The broadcast, with pending_count.
application/json- response
One template sent to a list of recipients from one number, paced over time.
object*stringid*string1 <= length <= 64name*stringnumber_id*stringThe business number it sends from.
1 <= length <= 64template*The template every recipient gets.
status*stringscheduled, running, then completed when each recipient is sent, failed or skipped. paused: stopped early, also for a lapsed subscription. cancelled: after a cancel.
"scheduled""running""paused""completed""cancelled"mode*stringHow it is paced: regular (fixed messages a minute), smart (batches while the read rate holds its target) or risk (as fast as the number may send).
"regular""smart""risk"scheduled_at*|When it starts, or started: the scheduled_at it was created with, or the moment it was created for one started at once. Null when none was recorded.
time_zone*|The IANA time zone the creator gave, kept for display.
label_ids*array<>Labels added to each recipient's contact once its message is sent.
recipient_count*integerRecipients, each phone counted once.
0 <= value <= 9007199254740991sent_count*integer0 <= value <= 9007199254740991failed_count*integer0 <= value <= 9007199254740991read_count*integer0 <= value <= 9007199254740991pending_count*|Recipients not sent yet. Counted on GET /v1/broadcasts/{id}; null in a list.
started_at*|nullcompleted_at*|nullcreated_at*stringdate-timecurl -X GET 'https://api.whatsable.app/v1/broadcasts/string'{ "object": "broadcast", "id": "cm2v8w1a00001qz8h5e6f7g8h", "name": "October promo", "number_id": "cm2v8a1b20002qz8h9i0j1k2l", "template": { "id": "cm2v8t1a00001qz8habcd1234", "name": "october_promo", "language": "en_US" }, "status": "running", "mode": "regular", "scheduled_at": "2026-10-20T19:51:20Z", "time_zone": null, "label_ids": [ "cm2v8l1a00001qz8h2b3c4d5e" ], "recipient_count": 1200, "sent_count": 340, "failed_count": 4, "read_count": 120, "pending_count": 856, "started_at": "2026-10-20T19:51:21Z", "completed_at": null, "created_at": "2026-10-20T19:51:20Z"}