# `bird whatsapp templates list`

## Usage

```bash
bird whatsapp templates list [flags]
```

## Description

List the workspace's WhatsApp templates: each template's handle, its lifecycle, and where each of its languages stands. Content is not included; use `bird whatsapp templates versions get` for that.

Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

## Examples

```bash
bird whatsapp templates list
bird whatsapp templates list | jq -r '.data[].id'
bird whatsapp templates list --limit 50 --starting-after <cursor>
```

## Options

#### Filters

| Name                | Description                                                                                                                                                                                                                                                                           |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--category`        | Filter by template category. Known values: authentication, utility, marketing (others may exist).                                                                                                                                                                                     |
| `--q`               | A case-insensitive substring search across the template's slug, name, and description.                                                                                                                                                                                                |
| `--response-schema` | Print the fields this command returns, then exit                                                                                                                                                                                                                                      |
| `--scope`           | Filter by ownership tier: system for the built-in, Meta-approved template catalog, or workspace for the workspace's own templates. Omit to return both. Possible values: system, workspace.                                                                                           |
| `--status <value>…` | Filter by lifecycle status. Repeat the parameter to match any of several. Our built-in templates are always active. Known values: draft, pending, active, rejected, inactive (others may exist).                                                                                      |
| `--waba`            | Filter to a single WhatsApp Business Account by its Meta WABA ID: the same value each template reports in its own waba field. Our built-in templates belong to no account and are never returned when this is set, and an account your workspace does not hold returns an empty page. |

#### Pagination

| Name               | Description                                                                                                                                                                                                                                                                                                                                             |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--ending-before`  | Cursor from the prev\_cursor or refresh\_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev\_cursor returns the preceding page. refresh\_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since. |
| `--limit <n>`      | Maximum number of items to return per page.                                                                                                                                                                                                                                                                                                             |
| `--starting-after` | Cursor from the next\_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.                                                                                                                                                                                                          |

## Related

| Name                                                                                    | Description                                                    |
| --------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
| [`bird whatsapp templates create`](/docs/cli/reference/whatsapp-templates-create)       | Create a WhatsApp template, optionally seeding its first draft |
| [`bird whatsapp templates delete`](/docs/cli/reference/whatsapp-templates-delete)       | Delete a message template                                      |
| [`bird whatsapp templates duplicate`](/docs/cli/reference/whatsapp-templates-duplicate) | Duplicate a message template                                   |
| [`bird whatsapp templates get`](/docs/cli/reference/whatsapp-templates-get)             | Get a message template                                         |
| [`bird whatsapp templates update`](/docs/cli/reference/whatsapp-templates-update)       | Update a message template                                      |