FireFlo OMNI

The latest 50 messages sent through the API, newest first, each with every attempt on every channel. Narrow it with reference or status.

Needs the messages:read scope.

Query parameters

Field	Type	Required	Notes
`reference`	string	No	Only messages sent with this `reference`.
`status`	string	No	`delivering`, `postponed`, `succeeded`, `failed`, `expired` or `canceled`.

Request

curl "https://api.fireflo.au/v1/messages?reference=order-A-1042" \
  -H "Authorization: Bearer $OMNI_API_KEY"

import os

import requests

response = requests.get(
    "https://api.fireflo.au/v1/messages",
    headers={"Authorization": f"Bearer {os.environ['OMNI_API_KEY']}"},
    params={
        "reference": "order-A-1042",
    },
)
print(response.status_code, response.json())

const response = await fetch("https://api.fireflo.au/v1/messages?reference=order-A-1042", {
  headers: {
    Authorization: `Bearer ${process.env.OMNI_API_KEY}`,
  },
});
console.log(response.status, await response.json());

Response

200 OK — data holds up to 50 messages, shaped as in POST /v1/messages.

{
  "data": [
    {
      "id": "msg_8f14e45fceea167a5a36dedd4bea2543",
      "status": "succeeded",
      "to": "+919876543210",
      "reference": "order-A-1042",
      "purpose": "transactional",
      "test": false,
      "outcome": {
        "channel": "sms",
        "status": "delivered"
      },
      "error": null,
      "steps": [
        {
          "channel": "whatsapp",
          "succeed_on": "read",
          "within": 600
        },
        {
          "channel": "sms",
          "succeed_on": "delivered",
          "within": 900
        }
      ],
      "attempts": [
        {
          "step": 0,
          "channel": "whatsapp",
          "status": "timed_out",
          "code": null,
          "reason": null,
          "channel_message": "cm_918273",
          "at": "2026-10-05T09:14:22.518204+00:00",
          "updated": "2026-10-05T09:24:30.004117+00:00"
        },
        {
          "step": 1,
          "channel": "sms",
          "status": "delivered",
          "code": null,
          "reason": null,
          "channel_message": "cm_918411",
          "at": "2026-10-05T09:24:30.091562+00:00",
          "updated": "2026-10-05T09:24:36.710348+00:00"
        }
      ],
      "created": "2026-10-05T09:14:22.413512+00:00",
      "finished_at": "2026-10-05T09:24:36.710348+00:00"
    }
  ]
}

Errors

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

Status	Error code	When
403	`scope_missing`	The key doesn’t have the `messages: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

Routes

Templates

Contacts

Conversations

Senders

Calls

Usage

Webhooks

WhatsApp

SMS

Try it

GET /v1/messages

Query parameters

Request

Response

Errors

​Query parameters

​Request

​Response

​Errors

Query parameters

Request

Response

Errors