FireFlo OMNI

The Inbox’s conversations, the most recently active first: one thread per person, across every channel. Open conversations unless state says otherwise.

Needs the conversations:read scope.

Query parameters

Field	Type	Required	Notes
`state`	string	No	`open` (the default), `snoozed` or `closed`.
`channel`	string	No	Only conversations on this channel, e.g. `whatsapp`.
`unassigned`	string	No	`true`: only those assigned to nobody.
`unread`	string	No	`true`: only those with unread messages.
`q`	string	No	A name, a number or words from a message.
`limit`	integer	No	How many to answer with, 1 to 100. Default 50.
`starting_after`	string	No	The `next` of the previous page, to read the page after it.

Lists are paged: has_more says whether there is more, and next is what to pass as starting_after to read it (null on the last page).

Request

curl "https://api.fireflo.au/v1/conversations?state=open&unread=true&limit=20" \
  -H "Authorization: Bearer $OMNI_API_KEY"

import os

import requests

response = requests.get(
    "https://api.fireflo.au/v1/conversations",
    headers={"Authorization": f"Bearer {os.environ['OMNI_API_KEY']}"},
    params={
        "state": "open",
        "unread": "true",
        "limit": 20,
    },
)
print(response.status_code, response.json())

const response = await fetch("https://api.fireflo.au/v1/conversations?state=open&unread=true&limit=20", {
  headers: {
    Authorization: `Bearer ${process.env.OMNI_API_KEY}`,
  },
});
console.log(response.status, await response.json());

Response

200 OK

{
  "data": [
    {
      "id": "3f6b2a1e-8c4d-4e2a-9b7f-5d1c0e8a9f42",
      "contact": {
        "id": "3f6b2a1e-8c4d-4e2a-9b7f-5d1c0e8a9f42",
        "name": "Asha Rao",
        "phone": "+919876543210"
      },
      "channels": [
        "sms",
        "whatsapp"
      ],
      "state": "open",
      "snoozed_until": null,
      "assignee": {
        "name": "Priya Nair",
        "email": "priya@acme.in"
      },
      "priority": "normal",
      "labels": [
        "orders"
      ],
      "unread": 2,
      "waiting_since": "2026-10-05T09:02:17.120Z",
      "last_message_at": "2026-10-05T09:02:17.120Z",
      "created": "2026-08-14T05:22:40.015Z"
    }
  ],
  "has_more": false,
  "next": null
}

The conversation

Field	Notes
`id`	The person’s contact id: a conversation is one thread per person, across every channel.
`contact`	`{id, name, phone}`.
`channels`	The channels they have written or been written to on.
`state`	`open`, `snoozed` or `closed`; `snoozed_until` while snoozed.
`assignee`	`{name, email}` of the team member it is assigned to, or null.
`priority`	`normal`, `high` or `urgent`.
`labels`	Label names, sorted.
`unread`	How many of their messages haven’t been read.
`waiting_since`	Since when they have been waiting for an answer, or null.
`last_message_at`, `created`	The latest message, and when the thread began.

Errors

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

Status	Error code	When
400	`invalid_request`	`state` isn’t open, snoozed or closed (`field` is `state`).
400	`invalid_request`	`limit` isn’t 1 to 100, or `starting_after` isn’t an id from this list (`field` names it).
403	`scope_missing`	The key doesn’t have the `conversations: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/conversations

Query parameters

Request

Response

The conversation

Errors

​Query parameters

​Request

​Response

​The conversation

​Errors

Query parameters

Request

Response

The conversation

Errors