FireFlo OMNI

The account’s broadcasts, newest first, whether started in the panel or through the API.

Needs the broadcasts:read scope.

Query parameters

Field	Type	Required	Notes
`status`	string	No	`preparing`, `queued`, `scheduled`, `sending`, `paused`, `sent`, `failed` or `canceled`.
`channel`	string	No	Only this channel’s.
`limit`	integer	No	1 to 100; 50 by default.
`starting_after`	string	No	The last id of the previous page — `next` from it.

Request

curl "https://api.fireflo.au/v1/broadcasts?status=sending&limit=10" \
  -H "Authorization: Bearer $OMNI_API_KEY"

import os

import requests

response = requests.get(
    "https://api.fireflo.au/v1/broadcasts?status=sending&limit=10",
    headers={"Authorization": f"Bearer {os.environ['OMNI_API_KEY']}"},
)
print(response.status_code, response.json())

const response = await fetch("https://api.fireflo.au/v1/broadcasts?status=sending&limit=10", {
  headers: { Authorization: `Bearer ${process.env.OMNI_API_KEY}` },
});
console.log(response.status, await response.json());

Response

200 OK — has_more says whether there is another page, and next is the starting_after for it.

{
  "data": [
    {
      "id": "7c1e9b52-3f0a-4d8e-9b6c-2a5d4e1f8c33",
      "name": "Diwali offer",
      "channel": "whatsapp",
      "status": "sending",
      "purpose": "marketing",
      "recipients": 1840,
      "counts": {
        "skipped": 12,
        "sent": 1204,
        "delivered": 1179,
        "failed": 9,
        "waiting": 624
      },
      "percent": 66,
      "error": "",
      "scheduled_for": null,
      "created": "2026-10-06T09:12:04+05:30",
      "started": "2026-10-06T09:12:31+05:30",
      "finished": null
    }
  ],
  "has_more": false,
  "next": null
}

Errors

Every refusal is {"error": {"code", "message", "field"}}; field is there when one input is at fault.

Status	Error code	When
400	`invalid_request`	`status` or `limit` isn’t one (`field` names it), or `starting_after` isn’t an id from this list.
403	`scope_missing`	The key doesn’t have the `broadcasts:read` scope.

Any request can also be refused for its key, its account or its rate (key_required, invalid_key, account_suspended, plan_excludes_api, address_not_allowed, rate_limited); see the overview.

Overview

Account

Messages

Broadcasts

Routes

Templates

Contacts

Conversations

Senders

Calls

Usage

Reports

Webhooks

WhatsApp

SMS

Try it

GET /v1/broadcasts

Query parameters

Request

Response

Errors

​Query parameters

​Request

​Response

​Errors

Query parameters

Request

Response

Errors