---
title: "List SMS templates"
method: GET
path: "/v1/sms/templates"
tags: ["sms-templates"]
---

# List SMS templates

`GET /v1/sms/templates`

## Request

- Base URL: `https://us1.platform.bird.com`
- URL: `https://us1.platform.bird.com/v1/sms/templates`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `bird_session`

Returns SMS templates as a cursor-paginated list. The workspace's templates
come first, newest first, followed by our built-in templates by default.
Set `order=asc` to reverse this order.

Filter by scope, category, status, or language. Use `q` for a
case-insensitive substring match against slug, name, and description. The
response is shallow; read a version to retrieve its content and variables.

## Query parameters

- `scope` 'system' | 'workspace': Whether the template is one of our built-in templates (`system`) or one your workspace created (`workspace`).
- `category` 'transactional' | 'marketing' | 'authentication': Why messages use this template. Use `authentication` for one-time codes, `marketing` for promotions, and `transactional` for service messages.
- `status` 'draft' | 'pending' | 'active' | 'rejected' | 'inactive': Where the template stands as a whole. The same five states on every channel. - `draft`: nothing has ever gone live. - `pending`: nothing is live and at least one language is in review. - `active`: at least one language is live, so something can be sent. - `rejected`: it was reviewed and every language was refused. - `inactive`: nothing is live and nothing is in review, so content was withdrawn or was blocked before anything went live. A template with one language live is `active` even while another is still drafted or refused. Read `languages` for the state of each language and its reason. Which values a channel reports follows its review model. A channel whose content a third party reviews uses all five. On email and SMS, where content goes live on publish, a template is `draft`, `active` or `inactive`, and `pending` and `rejected` are reserved for the review stage coming to both, so a template reaching either is not a breaking change.
- `language` string: A language tag in BCP-47 form, for example `en` or `pt-BR`.
- `q` string
- `sort` 'created_at': Field to sort SMS templates and their versions by.
- `order` 'asc' | 'desc': Sort direction, ascending or descending.
- `limit` integer
- `starting_after` string
- `ending_before` string

## Headers

- `X-Workspace-Id` string
- `X-Organization-Id` string

## Response `200`

Paginated list of SMS templates.

- SMSTemplateList
  - `data` SMSTemplateSummary[], required: One page of SMS templates.
    - `id` string, required
    - `workspace_id` string, required
    - `slug` string, required: A template's slug: what you send it by, for example `welcome-email`. Email and SMS slugs stay fixed after creation. WhatsApp slugs can change only before the first submission. A slug can contain lowercase letters, numbers, hyphens, and underscores, has to start and end with a letter or a number, and can be up to 63 characters long.
    - `name` string, required: The template's display name.
    - `description` string, nullable, required: What the template is for. Null if it has no description.
    - `scope` 'system' | 'workspace', required: Whether the template is one of our built-in templates (`system`) or one your workspace created (`workspace`).
    - `status` 'draft' | 'pending' | 'active' | 'rejected' | 'inactive', required: Where the template stands as a whole. The same five states on every channel. - `draft`: nothing has ever gone live. - `pending`: nothing is live and at least one language is in review. - `active`: at least one language is live, so something can be sent. - `rejected`: it was reviewed and every language was refused. - `inactive`: nothing is live and nothing is in review, so content was withdrawn or was blocked before anything went live. A template with one language live is `active` even while another is still drafted or refused. Read `languages` for the state of each language and its reason. Which values a channel reports follows its review model. A channel whose content a third party reviews uses all five. On email and SMS, where content goes live on publish, a template is `draft`, `active` or `inactive`, and `pending` and `rejected` are reserved for the review stage coming to both, so a template reaching either is not a breaking change.
    - `category` 'transactional' | 'marketing' | 'authentication', required: Why messages use this template. Use `authentication` for one-time codes, `marketing` for promotions, and `transactional` for service messages.
    - `draft_version_id` string, required
    - `live_version_id` string, required
    - `published_version_id` string, required
    - `languages` object, required: Each language and its live or draft state, keyed by canonical BCP-47 tag.
    - `default_language` string, required: A language tag in BCP-47 form, for example `en` or `pt-BR`.
    - `available_languages` LanguageTag[], required: Languages the live version can currently send. Empty before first publication.
    - `last_submitted_at` string, date-time, nullable, required: When the template was last published. Null before first publication and for built-in templates.
    - `created_at` string, date-time, nullable, required: When the template was created. Null for built-in templates.
    - `updated_at` string, date-time, nullable, required: When the template was last modified. Null for built-in templates.
  - `next_cursor` string, nullable, required: Cursor for the next page. Pass back as `starting_after` to advance forward. `null` when no next page exists.
  - `prev_cursor` string, nullable, required: Cursor for the previous page. Pass back as `ending_before` to step backward. `null` when no previous page exists.
  - `refresh_cursor` string, nullable, required: Refresh anchor, the first row of this response. Pass back as `ending_before` to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-`null` whenever `data` is non-empty; `null` only on an empty page. Distinct from `prev_cursor`.

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Insufficient permissions
- `404`: Resource not found
- `422`: The request has invalid field values, violates a business rule, or carries a query parameter the endpoint does not declare. Field validation errors use `type: validation_error` and include the affected fields in `details`. Business-rule errors identify the failed rule in `type`.
- `429`: Rate limit exceeded
- `500`: Internal server error

---

[API](https://skmtc.dev/messagebird/apis/bird-api.md) · [All operations](https://skmtc.dev/messagebird/apis/bird-api/llms.txt) · [OpenAPI document](https://skmtc.dev/messagebird/apis/bird-api/revisions/3e2a50466454?raw)