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

> Your routes, and what a message that names none is tried on.

Your routes. `builtin_default` is what a message that names no route is tried on while none of yours is the default: each channel you have, in order, each waiting 15 minutes for delivery (or for sending, where a channel can't report delivery). When one of your routes is the default, `builtin_default` holds its steps.

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

## Request

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

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

  import requests

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

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

## Response

`200 OK`

```json theme={null}
{
  "data": [
    {
      "id": "b1d6e0a4-2f3c-4a5b-8e9d-7c6f5a4b3e21",
      "name": "whatsapp-then-sms",
      "steps": [
        {
          "channel": "whatsapp",
          "succeed_on": "read",
          "within": 600
        },
        {
          "channel": "sms",
          "succeed_on": "delivered",
          "within": 900
        }
      ],
      "default": true,
      "updated": "2026-10-02T11:40:05.217Z"
    }
  ],
  "builtin_default": [
    {
      "channel": "whatsapp",
      "succeed_on": "read",
      "within": 600
    },
    {
      "channel": "sms",
      "succeed_on": "delivered",
      "within": 900
    }
  ]
}
```

## 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 `routes: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.