Documentation
Sign inGet started

bird email templates list

Usage

代码示例
bird email templates list [flags]

Description

List email templates as a cursor page, covering both the workspace's own templates and Bird's built-in system templates. Filter by scope, category, source, or a search across slug, name, and description.
Returns a paginated JSON envelope; narrow with the filters below and page with --limit and --starting-after.

Examples

代码示例
bird email templates list
bird email templates list | jq -r '.data[].id'
bird email templates list --limit 50 --starting-after <cursor>

Options

Filters

NameDescription
--categoryFilter by template category. Possible values: transactional, marketing.
--qA case-insensitive substring search across the template's slug, name, and description.
--response-schemaPrint the fields this command returns, then exit
--scopeFilter by ownership tier — system for Bird's built-in templates, workspace for the workspace's own. Omit to return both. Possible values: system, workspace.
--sourceFilter by authoring format. Possible values: html.

Pagination

NameDescription
--ending-beforeCursor 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-afterCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
NameDescription
bird email templates createCreate an email template and its first editable draft
bird email templates deleteDelete an email template
bird email templates duplicateDuplicate an email template
bird email templates getGet an email template
bird email templates previewRender a template with sample values
bird email templates updateUpdate an email template