Channels and templates
List message templates
Lists message templates for SMS, WhatsApp and email with their status. Filter by channel, status, or active set to true.
Requires: desk.read scope, Converse licence.
Authorization
bearerAuth AuthorizationBearer <token>
A SautiDesk API key. An owner or admin makes it under Settings in SautiDesk for a named person and picks the scopes. The key is shown once. Send it as Authorization: Bearer <key>. It acts as that person and as nobody else.
In: header
Query Parameters
active?boolean
true to list only the templates that are switched on.
cursor?string
next_cursor from the previous page. Leave it out for the first page.
limit?integer
Page size: 100 by default, 100 at most.
channel?string
Only templates for this channel: sms, whatsapp or email.
status?string
Only templates with this approval status.
Response
OK
Example
{ "data": [ { "id": "3f2b8c1e-5a4d-4e7b-9c10-2d6a8e4f1b37", "workspace_id": "0d16f37b-483b-4345-9876-083e209b25ee", "name": "Amina Wanjiru", "title": "Order 1182 has not arrived", "channel": "sms", "language": "en", "category": "billing", "topic_id": "9fa907c4-af65-4b91-9848-7727c8534704", "subject": "Order 1182 has not arrived", "body_format": "plain", "header_kind": "text", "header_text": "Your order", "body": "Hi Amina, your order has shipped.", "footer": "Sent from SautiDesk", "buttons": [ { "kind": null, "text": null, "url": null, "phone": null, "example": null } ], "variables": [ { "key": null, "label": null, "source": null, "sample": null, "fallback": null, "field": null } ], "active": false, "starter_key": "example-value", "status": "open", "meta_template_id": "4085f74f-de05-41c9-9407-02ef5aac9079", "meta_reason": "", "meta_var_map": [ { "index": null, "key": null } ], "category_changed_at": "2026-10-14T08:30:00Z", "created_by": "2faf86ee-f691-403c-936d-bb2014aaf0d1", "created_at": "2026-10-14T08:30:00Z", "updated_at": "2026-10-14T08:30:00Z", "submitted_at": "2026-10-14T08:30:00Z", "reviewed_at": "2026-10-14T08:30:00Z" } ], "next_cursor": "eyJvIjoyNX0", "has_more": false, "waba_id": "3afc867a-7f4f-478d-963b-729cf4dd9b8c"}FieldTypeDescription
datarequiredobject[]idrequiredstring (uuid)workspace_idrequiredstring (uuid)namerequiredstringA name for it.titlerequiredstringA short title.channelrequiredstringThe channel to use: sms, whatsapp or email.languagerequiredstringThe language code of the template, for example en or sw.categoryrequiredstringThe name of the category.topic_idstring (uuid) | nullThe id of the topic the template is filed under.subjectrequiredstringThe subject line.body_formatrequiredstringHow the body is formatted. Plain text is the default.header_kindrequiredstringWhat the template header holds: none for no header, or text to use header_text.header_textrequiredstringThe header line of the template message.bodyrequiredstringThe message text.footerrequiredstringA short line shown at the bottom of the message.buttonsrequiredobject[]The buttons shown under a WhatsApp template message, each with a label and what it does.kindrequiredstringWhat kind it is.textrequiredstringYour own words for the nudge.urlstringphonestringexamplestringvariablesrequiredobject[]The values for the template's placeholders, each by name.keyrequiredstringlabelrequiredstringA short name to recognise it by.sourcerequiredstringsamplerequiredstringfallbackstringfieldrequiredstringactiverequiredbooleanTrue to switch it on, false to switch it off.starter_keystringstatusrequiredstringThe status to set.meta_template_idstringmeta_reasonstringmeta_var_mapobject[]indexrequiredintegerkeyrequiredstringcategory_changed_atstring (date-time) | nullcreated_bystring (uuid) | nullcreated_atrequiredstring (date-time)updated_atrequiredstring (date-time)submitted_atstring (date-time) | nullreviewed_atstring (date-time) | nullnext_cursorrequiredstring | nullhas_morerequiredbooleanwaba_idstringcurl -X GET "https://api.sautidesk.com/v1/desk/templates"