Sign inGet Started

bird amb templates list

Usage

Code example
bird amb templates list [flags]

Description

List workspace and built-in Apple Messages templates as a cursor page. Filter by scope, category, status, content kind, language, or a search across slug, name, and description. Read a version to retrieve content and variables.

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

Procedure

Step 1 of 3 of "Reply to an Apple Messages conversation from a template". Next: bird amb templates get.

Examples

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

Options

Filters

NameDescription
--categoryReturn templates in this category. Possible values: transactional, marketing.
--content-kindReturn templates whose live or draft content is this kind. Possible values: text, attachment, rich_link, quick_reply, list_picker, time_picker, form, apple_pay, authenticate, imessage_app, interactive.
--languageReturn templates whose published content contains this language, after the tag is canonicalized. Draft-only languages do not match.
--qA case-insensitive substring search across slug, name, and description.
--response-schemaPrint the fields this command returns, then exit
--scopeFilter by who owns the template. Use system for built-in templates and workspace for templates your workspace created. Possible values: system, workspace.
--statusReturn templates with this lifecycle status. Possible values: draft, pending, active, rejected, inactive.

Pagination

NameDescription
--ending-beforeCursor 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. Allowed range: 1 to 100.
--orderSort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field. Possible values: asc, desc.
--sortField to sort by. Possible values: created_at.
--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 amb templates getGet an Apple Messages template

Continue with the documentation, guides and examples for this topic.