> ## 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/channels/whatsapp/templates

> Your WhatsApp message templates, with their approval status.

Your WhatsApp message templates, with their approval status. Filter by `status`.

<Note>Needs the `whatsapp.templates:read` scope.</Note>

## Query parameters

| Field | Type | Required | Notes |
| :- | :- | :- | :- |
| `status` | string | No | `approved`, `pending`, `rejected`, `paused` or `disabled`. |

A template has `id`, `name`, `language`, `status` (`approved`, `pending`, `rejected`, `paused` or `disabled`), `category` (`utility`, `marketing` or `authentication`), `components` (its parts as WhatsApp holds them: header, body, footer, buttons) and `reason` (why it was rejected, or empty). On a number FireFlo hosts for you, you see and change only the templates you submitted.

## Request

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

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

  import requests

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

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

## Response

`200 OK`

```json theme={null}
{
  "data": [
    {
      "id": "1029384756473829",
      "name": "order_shipped",
      "language": "en",
      "status": "approved",
      "category": "utility",
      "components": [
        {
          "type": "BODY",
          "text": "Hi {{1}}, your order {{2}} has shipped."
        },
        {
          "type": "FOOTER",
          "text": "Acme Retail"
        }
      ],
      "reason": ""
    }
  ]
}
```

## Errors

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

| Status | Error code | When |
| :- | :- | :- |
| 400 | `invalid_request` | `status` isn't one of its values (`field` is `status`). |
| 404 | `channel_off` | The account doesn't have WhatsApp on. |
| 409 | `provider_refused` | WhatsApp refused it; the message gives WhatsApp's reason. |
| 403 | `scope_missing` | The key doesn't have the `whatsapp.templates: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.