bird sms templates list
Usage
Code example
bird sms templates list [flags]Description
List workspace and built-in SMS templates as a cursor page. Filter by scope, category, status, 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 "Send an SMS from a template". Next: bird sms templates get.
Examples
Code example
bird sms templates list
bird sms templates list | jq -r '.data[].id'
bird sms templates list --limit 50 --starting-after <cursor>Options
Filters
| Name | Description |
|---|---|
| --category | Return templates in this category. Possible values: transactional, marketing, authentication. |
| --language | Return templates whose published content contains this language, after the tag is canonicalized. Draft-only languages do not match. |
| --q | A case-insensitive substring search across slug, name, and description. |
| --response-schema | Print the fields this command returns, then exit |
| --scope | Filter by who owns the template. Use system for built-in templates and workspace for templates your workspace created. Possible values: system, workspace. |
| --status | Return templates with this lifecycle status. Possible values: draft, pending, active, rejected, inactive. |
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. |
| --order | Sort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field. Possible values: asc, desc. |
| --sort | Field to sort by. Possible values: created_at. |
| --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 sms templates get | Get an SMS template |
Related resources
Continue with the documentation, guides and examples for this topic. Resources are in English.
Watch the guideSending an SMS with a templateUse the toolPreview message segmentsExplore the capabilitySMS content and templatesFollow the learning pathBuild your first integration
Try the practice and get an implementation brief