List SMS templates

GET/sms/templates

Returns the workspace's SMS templates, newest first. These are the templates the SMS campaign wizard and the automations Send SMS block offer. Inactive templates are left out unless include_inactive=true.

Requires Authorization: Bearer <api_key>. Create a key in the Inspra dashboard under Workspace Settings → API Keys.

Query parameters

pageinteger≥ 1optional
1-based page index. Defaults to 1.
Default 1
page_sizeinteger1–100optional
Items per page. Defaults to 20. Hard-capped at 100 by the server.
Default 20
searchstringoptional
Case-insensitive substring match on the name or body.
categorystringoptional
include_inactivebooleanoptional
Default false

Response 200 OK

Paginated template list.

dataobject[]required
9 fields
- idstringuuidoptional
- namestring0–255 charsoptional
- categorystringnullable0–100 charsoptional
- bodystring0–1600 charsoptional
- variablesstring[]optional
  Detected from the body; read-only.
- segmentsintegeroptional
- is_activebooleanoptional
  Inactive templates are hidden from pickers but keep working where already linked.
- created_atstringdate-timeoptional
- updated_atstringdate-timeoptional
paginationobjectrequired
Echoed pagination block on every list response. page and page_size match the request (or the defaults if omitted); total is the count of matching rows across all pages.
3 fields
- pageinteger≥ 1required
  1-based page index of this response.
- page_sizeinteger≥ 1required
  Number of items per page (request cap is 100).
- totalinteger≥ 0required
  Total matching items across all pages.

Errors

401Unauthorized
Missing, malformed, or invalid API key.
403Forbidden
Workspace unavailable, suspended, or paywalled.
429Too Many Requests
Workspace request limit exceeded; shared across all its API keys.