Broadcasts
List broadcasts
Returns the broadcasts on your account, newest first, each with freshly counted stats.
GET
/
broadcasts
cURL
curl --request GET \
--url https://api.vobiz.ai/api/v1/sms/broadcasts \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'from vobiz import Vobiz
client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")
client.sms.broadcasts.list_broadcasts()
const options = {
method: 'GET',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/sms/broadcasts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"broadcasts": [
{
"id": "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
"accountId": "MA_XXXXXXXX",
"name": "October pricing update",
"from": "+14155550100",
"channel": "sms",
"template": "Hi {{name}}, your refund of {{amount}} is on its way.",
"status": "completed",
"scheduledAt": null,
"ratePerSecond": 5,
"tag": "pricing-oct",
"dltEntityId": "",
"dltHeaderId": "",
"dltTemplateId": "",
"columns": [
"phone",
"name",
"amount"
],
"stats": {
"total": 3,
"pending": 0,
"sent": 3,
"delivered": 0,
"failed": 0,
"optedOut": 0,
"skipped": 0
},
"createdAt": "2026-10-12T10:30:00Z",
"updatedAt": "2026-10-12T11:05:12Z",
"startedAt": "2026-10-12T11:05:10Z",
"completedAt": "2026-10-12T11:05:12Z"
}
],
"total": 1
}Authorizations
Your Vobiz account Auth ID (MA_XXXXXXXX).
Your Vobiz account Auth Token.
Query Parameters
Maximum number of broadcasts to return, from 1 to 500. Defaults to 50 when you omit it or pass 0. A value above 500 returns 400 with limit must be between 1 and 500, and a non-integer returns 400 with limit must be an integer.
Required range:
1 <= x <= 500Number of broadcasts to skip before the page starts, for paging through results with limit. Defaults to 0. A negative value returns 400 with offset must be >= 0, and a non-integer returns 400 with offset must be an integer.
Required range:
x >= 0Response
A page of broadcasts.
One page of broadcasts, newest first, with the total count for paging.
Was this page helpful?
⌘I
cURL
curl --request GET \
--url https://api.vobiz.ai/api/v1/sms/broadcasts \
--header 'X-Auth-ID: <api-key>' \
--header 'X-Auth-Token: <api-key>'from vobiz import Vobiz
client = Vobiz(api_key="MA_XXXXXXXX", auth_token="YOUR_AUTH_TOKEN")
client.sms.broadcasts.list_broadcasts()
const options = {
method: 'GET',
headers: {'X-Auth-ID': '<api-key>', 'X-Auth-Token': '<api-key>'}
};
fetch('https://api.vobiz.ai/api/v1/sms/broadcasts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"broadcasts": [
{
"id": "3f8d2a6e-5b1c-4e7f-a9d0-2c4b6e8f1a35",
"accountId": "MA_XXXXXXXX",
"name": "October pricing update",
"from": "+14155550100",
"channel": "sms",
"template": "Hi {{name}}, your refund of {{amount}} is on its way.",
"status": "completed",
"scheduledAt": null,
"ratePerSecond": 5,
"tag": "pricing-oct",
"dltEntityId": "",
"dltHeaderId": "",
"dltTemplateId": "",
"columns": [
"phone",
"name",
"amount"
],
"stats": {
"total": 3,
"pending": 0,
"sent": 3,
"delivered": 0,
"failed": 0,
"optedOut": 0,
"skipped": 0
},
"createdAt": "2026-10-12T10:30:00Z",
"updatedAt": "2026-10-12T11:05:12Z",
"startedAt": "2026-10-12T11:05:10Z",
"completedAt": "2026-10-12T11:05:12Z"
}
],
"total": 1
}