> ## Documentation Index
> Fetch the complete documentation index at: https://omni.fireflo.au/llms.txt
> Use this file to discover all available pages before exploring further.

# GET /v1/contacts

> Your contacts, newest first, found by phone or filtered by name, number or tag.

Your contacts, newest first. Find one person by `phone` — any number they have had, not just their current one — or filter by name or number (`q`) or by `tag`.

<Note>Needs the `contacts:read` scope.</Note>

## Query parameters

| Field | Type | Required | Notes |
| :- | :- | :- | :- |
| `phone` | string | No | A number they have, or have had. |
| `q` | string | No | Part of a name or a number. |
| `tag` | string | No | Only contacts with this tag. |
| `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

<CodeGroup>
  ```bash cURL theme={null}
  curl "https://api.fireflo.au/v1/contacts?tag=vip&limit=20" \
    -H "Authorization: Bearer $OMNI_API_KEY"
  ```

  ```python Python theme={null}
  import os

  import requests

  response = requests.get(
      "https://api.fireflo.au/v1/contacts",
      headers={"Authorization": f"Bearer {os.environ['OMNI_API_KEY']}"},
      params={
          "tag": "vip",
          "limit": 20,
      },
  )
  print(response.status_code, response.json())
  ```

  ```javascript Node theme={null}
  const response = await fetch("https://api.fireflo.au/v1/contacts?tag=vip&limit=20", {
    headers: {
      Authorization: `Bearer ${process.env.OMNI_API_KEY}`,
    },
  });
  console.log(response.status, await response.json());
  ```
</CodeGroup>

## Response

`200 OK`

```json theme={null}
{
  "data": [
    {
      "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"
    }
  ],
  "has_more": true,
  "next": "3f6b2a1e-8c4d-4e2a-9b7f-5d1c0e8a9f42"
}
```

### The contact

| 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. |

## Errors

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

| Status | Error code | When |
| :- | :- | :- |
| 400 | `invalid_request` | `limit` isn't 1 to 100, or `starting_after` isn't an id from this list (`field` names it). |
| 400 | `invalid_request` | `phone` isn't a valid number (`field` is `phone`). |
| 403 | `scope_missing` | The key doesn't have the `contacts: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](/api-reference/overview).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.