List available message templates
GET
/v1/whatsapp/templates
curl -X GET "https://us1.platform.bird.com/v1/whatsapp/templates" \
-H "Authorization: Bearer $TOKEN"Returns the message templates available to this workspace.
Response Payload
data
array of object
verplicht
The templates available to your workspace.
Onderliggende attributen tonen
data.name
string
verplicht
The template's stable handle. Pass it as the template reference when sending.
data.scope
string
verplicht
Whether the template is a built-in Bird template (system) or one your workspace authored (workspace).
data.language
string
verplicht
The language code of this template variant (for example en or pt_BR).
data.category
object
verplicht
Content classification applied to messages sent from this template.
data.status
object
verplicht
The template's review and health status.
data.components
array of object
verplicht
The content blocks that make up the template, in display order.
Onderliggende attributen tonen
data.components.type
string
verplicht
The content block's type within the template.
data.components.text
string
The block's text content, with any variable placeholders shown inline. Present when the block carries text.
data.components.example_parameters
array of object
Example values for this block's variables, in placeholder order — one per {{n}}. Use them to see what a filled message looks like. Present when the block has variables.
Onderliggende attributen tonen
data.components.example_parameters.type
object
verplicht
The kind of value this parameter accepts.
data.components.example_parameters.text
string
An example value for a text parameter. Present when type is text.
data.components.buttons
array of object
The buttons attached to this block. Present when the block carries buttons.
Onderliggende attributen tonen
data.components.buttons.type
string
verplicht
The button's behavior type.
data.components.buttons.text
string
verplicht
The button's label text.
data.components.buttons.url
string
The URL the button opens, with any variable placeholder shown inline. Present on link buttons.
data.components.buttons.example_parameters
array of object
Example values for this button's variables, in placeholder order. Present when the button URL has variables.
Onderliggende attributen tonen
data.components.buttons.example_parameters.type
object
verplicht
The kind of value this parameter accepts.
data.components.buttons.example_parameters.text
string
An example value for a text parameter. Present when type is text.