Skip to main content
GET
List WhatsApp templates
List the WhatsApp templates in the authenticated workspace. Each template is returned as its renderable definition: the Meta-style components, the Sagepilot variable parameters mapped onto those components, and the template-level wa_retry_config (null when none has been saved). Use Get WhatsApp template to read a single template by ID.

Required access

Query parameters

integer
default:"1"
Page number, starting at 1.
integer
default:"12"
Templates per page. Maximum value is 200.
string
default:"all"
Filter by template status, matched case-insensitively against the stored status, for example approved, pending, rejected, or draft. all returns every template that is not deleted.
Case-insensitive substring match on the template name.
string
Filter by Meta category: MARKETING, UTILITY, or AUTHENTICATION.
string
Return only templates that belong to one WhatsApp channel. Use the channel_id values returned by this endpoint.
boolean
default:"true"
Set to false for a lightweight listing without components. Lightweight items use a metadata shape rather than the full definition.

Response

object[]
required
One template definition per result, ordered newest first.
string
Template UUID. Pass it as template_id to Get WhatsApp template.
string
WhatsApp channel the template belongs to, when present.
string
Template name as registered with Meta. Case-sensitive.
string
Meta language code, for example en or en_US.
string
Meta category: MARKETING, UTILITY, or AUTHENTICATION.
string
Meta review status, for example APPROVED, PENDING, REJECTED, or DRAFT.
string
TEMPLATE or CAROUSEL.
object[]
Meta-style components with {{n}} placeholders. Omitted when include_content=false.
object
Sagepilot variable and fixed-value mappings for each placeholder.
object
Template retry settings, or null when the platform default applies. Same shape as in Get WhatsApp template.
integer
Total number of templates that match the filters across all pages.
integer
Number of pages at the requested page_size.

Errors