Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
One contact, with every number and identifier, their fields, tags and consent.
contacts:read scope.| Field | Type | Required | Notes |
|---|---|---|---|
contact_id | string | Yes | The contact’s id. |
curl https://api.fireflo.au/v1/contacts/3f6b2a1e-8c4d-4e2a-9b7f-5d1c0e8a9f42 \
-H "Authorization: Bearer $OMNI_API_KEY"
import os
import requests
response = requests.get(
"https://api.fireflo.au/v1/contacts/3f6b2a1e-8c4d-4e2a-9b7f-5d1c0e8a9f42",
headers={"Authorization": f"Bearer {os.environ['OMNI_API_KEY']}"},
)
print(response.status_code, response.json())
const response = await fetch("https://api.fireflo.au/v1/contacts/3f6b2a1e-8c4d-4e2a-9b7f-5d1c0e8a9f42", {
headers: {
Authorization: `Bearer ${process.env.OMNI_API_KEY}`,
},
});
console.log(response.status, await response.json());
200 OK
{
"id": "3f6b2a1e-8c4d-4e2a-9b7f-5d1c0e8a9f42",
"name": "Asha Rao",
"phone": "+919876543210",
"identifiers": [
{
"kind": "phone",
"value": "+919876543210",
"primary": true
},
{
"kind": "phone",
"value": "+919812345678",
"primary": false
},
{
"kind": "email",
"value": "asha@acme.in",
"primary": false
}
],
"fields": {
"city": "Pune",
"loyalty_tier": "gold"
},
"tags": [
"newsletter",
"vip"
],
"consent": {
"do_not_contact": false,
"reason": "",
"until": null,
"opted_out_at": null
},
"timezone": "Asia/Kolkata",
"quiet_hours": {
"start": "21:00:00",
"end": "08:00:00"
},
"created": "2026-08-14T05:21:09.338Z",
"updated": "2026-10-05T09:14:22.413Z"
}
| Field | Notes |
|---|---|
id | The contact’s id. |
phone | Their main number, in international format. |
identifiers | Every way they are known: their main number first (primary: true), then older numbers and other identifiers. kind is phone, email, external_id, whatsapp_id, rcs_id or anonymous_id. |
fields | Their values for your account’s contact fields, by field key. |
tags | Tag names, sorted. |
consent | do_not_contact (nothing is sent to them on any channel while true), its reason and until (null for good), and opted_out_at (when they opted out of marketing, or null). |
timezone, quiet_hours | Their time zone, and the hours not to message them ({start, end}, or null). |
created, updated | When the contact was added and last changed. |
{"error": {"code", "message", "field"}}; field is there when one input is at fault.
| Status | Error code | When |
|---|---|---|
| 404 | not_found | No contact has that id on this account. |
| 403 | scope_missing | The key doesn’t have the contacts:read scope. |
key_required, invalid_key, account_suspended, plan_excludes_api, address_not_allowed, rate_limited); see the overview.