> ## 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/senders

> Everything your messages and calls can come from, on every channel you have.

Everything your messages and calls can come from, on every channel you have, in one shape: SMS sender IDs (with their registration status), your WhatsApp number, RCS bots and Voice numbers. A channel that can't be asked right now is named in `unavailable`, and the rest are still listed.

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

## Query parameters

| Field | Type | Required | Notes |
| :- | :- | :- | :- |
| `channel` | string | No | Only this channel's: one the account has, e.g. `sms`. |
| `status` | string | No | `approved`, `pending`, `rejected`, `withdrawn`, `active` or `inactive`. |

Each sender has `channel`, `id`, `kind` (`sender_id`, `number` or `bot`), `value` (what the person sees), `name`, `status`, `default` (used when a send names none) and `details`, which depend on the channel: an SMS sender ID's `reason` for a decision, whether a WhatsApp number is FireFlo's `shared` one, an RCS bot's `category` and `countries`, where a Voice number's `calls_go_to`. Voice appears as the channel `firetone`.

## Request

<CodeGroup>
  ```bash cURL theme={null}
  curl "https://api.fireflo.au/v1/senders?channel=sms" \
    -H "Authorization: Bearer $OMNI_API_KEY"
  ```

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

  import requests

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

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

## Response

`200 OK`

```json theme={null}
{
  "data": [
    {
      "channel": "sms",
      "id": "sms-sender-4182",
      "kind": "sender_id",
      "value": "ACMEIN",
      "name": "Acme orders",
      "status": "approved",
      "default": false,
      "details": {
        "reason": ""
      }
    },
    {
      "channel": "whatsapp",
      "id": "whatsapp-number",
      "kind": "number",
      "value": "+91 11 4000 1234",
      "name": "Acme Retail",
      "status": "active",
      "default": true,
      "details": {
        "shared": false
      }
    }
  ],
  "unavailable": [
    {
      "channel": "firetone",
      "message": "Voice can't be asked right now. Try again shortly."
    }
  ]
}
```

## Errors

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

| Status | Error code | When |
| :- | :- | :- |
| 400 | `invalid_request` | `channel` isn't one the account has, or `status` isn't one of the six (`field` names it). |
| 403 | `scope_missing` | The key doesn't have the `senders: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.