Skip to main content
GET
List WhatsApp templates

Authorizations

Authorization
string
header
required

Organization API key using Authorization: Bearer sk_....

Query Parameters

filter
object

Fields encoded with qs bracket notation.

skip
number
default:0

Pagination offset.

Required range: x >= 0
Example:

0

take
number
default:20

Pagination limit.

Required range: 1 <= x <= 100
Example:

20

Response

WhatsApp templates list

id
string
required

Unique identifier of the WhatsApp template.

Example:

"wat_1234567890abcdefghij"

createdAt
string<date-time>
required

When the template was created.

updatedAt
string<date-time>
required

When the template was last updated.

organizationId
string | null
required

Organization that owns the template.

whatsappAccountId
string | null
required

WhatsApp Business Account the template belongs to.

channelId
string | null
required

Legacy 360dialog channel, if any.

name
string
required

Template name registered with WhatsApp.

Example:

"recordatorio_pago"

status
enum<string>
required

Provider approval status.

Available options:
APPROVED,
ARCHIVED,
DELETED,
DISABLED,
REJECTED,
PAUSED,
FLAGGED,
IN_APPEAL,
LIMIT_EXCEEDED,
PENDING,
PENDING_DELETION,
SUBMITTED,
UNKNOWN
rejectedReason
enum<string>
required

Why the provider rejected the template, if it did.

Available options:
ABUSIVE_CONTENT,
INCORRECT_CATEGORY,
INVALID_FORMAT,
PROMOTIONAL,
SCAM,
TAG_CONTENT_MISMATCH,
NONE
category
enum<string>
required

WhatsApp template category.

Available options:
AUTHENTICATION,
FREE_SERVICE,
MARKETING,
UTILITY
allowCategoryChange
boolean
required

Whether WhatsApp may recategorize the template.

language
string
required

Template language code.

Example:

"es_MX"

parameterFormat
enum<string>
required

Whether variables are positional or named.

Available options:
NAMED,
POSITIONAL
deletedAt
string<date-time> | null
required

When the template was deleted, if applicable.

deletedById
string | null
required

User who deleted the template.

components
object[]

Header, body, footer, and button components.