List SMS templates
GET
/v1/sms/templates
curl -X GET "https://us1.platform.bird.com/v1/sms/templates" \
-H "Authorization: Bearer $TOKEN"Returns the SMS templates you can send from, including Bird's built-in templates. Filter by scope, category, or language; the catalogue is small and returned in full, so this list is not paginated. To read one template's variables before sending with it, use Get an SMS template.
Queryparameters
scope
string
Keep only templates of this scope: system for Bird's built-in templates, workspace for templates authored in your workspace. Omit for all. Workspace-authored SMS templates are not available yet, so workspace currently matches nothing.
Possible values: system, workspace
category
string
Keep only templates whose category matches. Omit for all categories.
Possible values: transactional, marketing, authentication, service
language
string
Keep only templates available in this language, as a BCP-47 tag. Matches the template's available_languages entries exactly, with no fallback.
Response Payload
data
array of object
verplicht
The templates available to your workspace. The catalogue is small and returned in full; this list is not paginated.
Onderliggende attributen tonen
data.id
string
verplicht
Unique identifier for the template.
data.name
object
verplicht
The template's stable handle. Pass it (or the id) as the template reference when sending.
data.description
string
verplicht
Human-readable description of what the template is for.
data.scope
string
verplicht
Whether the template is a built-in Bird template (system) or one your workspace authored (workspace).
Possible values: system, workspace
data.category
object
verplicht
Content classification applied to messages sent from this template.
data.body
string
verplicht
The template body in its default language, shown for preview. Variable placeholders appear inline (for example {{ code }}).
data.variables
array of object
verplicht
The typed slots this template fills in from the values you supply when sending.
Onderliggende attributen tonen
data.variables.key
string
verplicht
The parameters key this slot is filled with.
data.variables.type
string
verplicht
The value type this slot accepts. Open enum — treat any unrecognized value as a future type rather than an error. SMS templates use the typed slots (code, amount, …); email templates use text.
Possible values (may grow over time): code, ttl, count, ref, date, date_time, amount, currency, text
data.variables.required
boolean
verplicht
Whether the slot must be supplied when sending. Advisory for email templates, where a missing value renders as empty rather than rejecting the send.
data.variables.constraint
string
verplicht
A human-readable description of the accepted values.
data.available_languages
array of string
verplicht
The languages this template is available in, as BCP-47 tags.
data.status
string
verplicht
The template's lifecycle state. active means the template can be sent; every built-in Bird template is active. draft (being edited), pending (submitted for review), approved (passed review), and rejected (failed review) describe a workspace-authored template's authoring lifecycle; workspace-authored SMS templates are not available yet, so today every template is active.
Possible values: active, draft, pending, approved, rejected
data.draft_version_id
nullable string
verplicht
The current editable draft version. Always null today: SMS templates are not yet versioned; present for parity with email templates.
data.published_version_id
nullable string
The currently published version, or null if the template has never been published. Always null today: SMS templates are not yet versioned; present for parity with email templates.
data.revision
nullable integer
verplicht
The draft's revision counter. Always null today: SMS templates are not yet versioned; present for parity with email templates.
data.created_at
nullable string
verplicht
When the template was created. Null for built-in templates.
data.updated_at
nullable string
verplicht
When the template was last updated. Null for built-in templates.