bird email list
Usage
Code example
bird email list [flags]Description
List sent email messages, newest first, as a cursor page ({data, next_cursor, …}). Pass next_cursor back as starting_after to fetch the next page. Filter by creation time with the half-open range created_after (inclusive) and created_before (exclusive). For a single UTC day, created_after is that day at 00:00:00Z and created_before is the next day at 00:00:00Z.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.
Examples
Code example
bird email list
bird email list | jq -r '.data[].id'
bird email list --limit 50 --starting-after <cursor>Options
Filters
| Name | Description |
|---|---|
| --category | Filter by category. Possible values: marketing, transactional. |
| --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. |
| --from | Filter by sender address. Exact match against the message from field. The address is normalized to lowercase before comparison. |
| --response-schema | Print the fields this command returns, then exit |
| --status | Filter by aggregate delivery status. Possible values: scheduled, accepted, processed, deferred, delivered, partial_failure, bounced, complained, rejected, canceled. |
| --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. |
| --to | Filter by recipient address. Exact match against any to/cc/bcc recipient on the message. The address is normalized to lowercase before comparison. |
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 email cancel | Cancel a scheduled message |
| bird email content | Get stored message content |
| bird email get | Get a message |
| bird email recipients | List recipients of a message |
| bird email send | Send an email message |
| bird email send-batch | Send a batch of email messages in one call |
Related resources
Continue with the documentation, guides and examples for this topic. Resources are in English.
Watch the guideGetting started with emailExplore the capabilityEmailFollow the learning pathBuild your first integrationImplementation guideSend your first email
Try the practice and get an implementation brief