# `bird amb list`

## Usage

```bash
bird amb list [flags]
```

## Description

Lists your workspace's incoming and outgoing Apple messages with cursor pagination. Filter by business or conversation to inspect one exchange; sent records Apple gateway acceptance.

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

## Examples

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

## Options

#### Filters

| Name                | Description                                                                                                                                                                                                                                    |
| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--business-id`     | Filter to messages belonging to this business.                                                                                                                                                                                                 |
| `--category`        | Filter to outbound messages sent with this category, exact match.                                                                                                                                                                              |
| `--conversation-id` | Filter to messages belonging to this conversation.                                                                                                                                                                                             |
| `--created-after`   | Limits the response to resources created at or after this timestamp. Combine it with created\_before to select a time window. Use an RFC 3339 timestamp with a timezone offset.                                                                |
| `--created-before`  | Limits the response to resources created before this timestamp. Combine it with created\_after to select a time window. Use an RFC 3339 timestamp with a timezone offset.                                                                      |
| `--direction`       | Filter to received (inbound) or sent (outbound) messages. Possible values: outbound, inbound.                                                                                                                                                  |
| `--kind`            | Filter to messages whose content is this shape. Possible values: text, attachment, rich\_link, quick\_reply, list\_picker, time\_picker, form, apple\_pay, authenticate, imessage\_app, interactive.                                           |
| `--response-schema` | Print the fields this command returns, then exit                                                                                                                                                                                               |
| `--status`          | Filter to messages with this status. Possible values: accepted, sent, send\_failed, rejected, received.                                                                                                                                        |
| `--tag <value>…`    | Filter by tag. Accepts name to match any record carrying that tag name, or name:value to match a specific tag pair (for example category:welcome). Repeat the parameter to add more tags. A record must match every tag listed to be returned. |

#### 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 amb get`](/docs/cli/reference/amb-get)                 | Get a message                           |
| [`bird amb list-events`](/docs/cli/reference/amb-list-events) | List events for a message               |
| [`bird amb send`](/docs/cli/reference/amb-send)               | Reply to an Apple Messages conversation |

## Related resources

- [Should I use a Bird SDK or call the API directly?](/explained/platform/should-i-use-an-sdk-or-call-the-api-directly) (answer)
- [Build your first integration](/learn/paths/integration) (course)
- [Send your first email](/docs/get-started/send-your-first-email) (docs)

[Get an implementation brief](/learn/workspace?topic=api-basics)