bird email templates list
Usage
Code example
bird email templates list [flags]Description
List email templates as a cursor page. The list covers both the workspace's own templates and our built-in system templates. Filter to one tier with scope, and filter further by category, source, theme, or a search across slug, name, and description. A theme narrows the built-in catalog to one of its five visual themes, so naming one returns built-ins alone.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.
Examples
Code example
bird email templates list
bird email templates list | jq -r '.data[].id'
bird email templates list --limit 50 --starting-after <cursor>Options
Filters
| Name | Description |
|---|---|
| --category | Return only transactional or marketing templates; omit to return both categories. Possible values: transactional, marketing. |
| --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 who owns the template. Use system for our built-in templates and workspace for the ones your workspace created. Leave it out to get both. Possible values: system, workspace. |
| --source | Return only templates authored in this format. Currently, html is the only supported value. Possible values: html. |
| --theme | Filter by the visual theme a built-in template is designed in. Only our built-in templates have a theme, so naming one returns built-ins alone. Possible values: arcane, barebone, matte, protocol, studio. |
Pagination
| Name | Description |
|---|---|
| --ending-before | Cursor from the prev_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. |
| --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 templates create | Create an email template and its first editable draft |
| bird email templates delete | Delete an email template |
| bird email templates duplicate | Duplicate an email template |
| bird email templates get | Get an email template |
| bird email templates preview | Preview a template with sample values |
| bird email templates update | Update an email template |