Get WhatsApp Templates

Published on Mar 19, 2026

3 minute(s) read

Get

/whatsapp/templates/{ENCRYPTED_STREAM_ID}

This API retrieves a list of all active Meta-approved WhatsApp message templates configured for a specified channel.

Path Parameters

Required Path parameter is the Encrypted Channel ID, which can be found in the WhatsApp Channel Settings beneath the channel's name.

Query Parameters

Query parameters can filter and organize the request:

Language

Enter the template's language code (en, he, es, etc.)
Supports comma-separated values

Category

Enter the WhatsApp template category (Marketing, Utility, Authentication)
Supports comma-separated values

Pagination (limit and offset)

These optional query parameters help control and manage the returned WhatsApp templates by splitting them into smaller, manageable chunks.

limit - Number of templates to return per request (default: 50, max: 200)
offset - Page index indicating where to start retrieving results (0, 1, 2, ...). The starting point is calculated as: start_index = offset × limit (default: 0)

Example:

If there are 50 templates and the limit = 20:

offset = 0 → returns templates 1–20
offset = 1 → returns templates 21–40
offset = 2 → returns templates 41–50

Response Payload

The response payload may include:

Variable placeholders (e.g., {{1}}, {{2}})
Header format types (TEXT, IMAGE, VIDEO, DOCUMENT)
Button types (QUICK_REPLY, URL, PHONE).

Note:

Only templates that are approved by Meta and active in CommBox are returned; Meta's quality status is not included in the response.
The API returns the template business “friendly name” when defined. If not, it defaults to the official WhatsApp business name.
Although offset conceptually represents skipped items, in this API it is page-based, not item-based.

Request Examples:

All active and approved Marketing templates in English:

GET /whatsapp/templates/Y0nJy1h_buU91T6QNroQ%3d?language=en&category=marketing

Retrieving 20 active and approved templates – the 2nd batch of 20 out of 50:

GET /whatsapp/templates/Y0nJy1h_buU91T6QNroQ%3d?limit=20&offset=1

Security

HTTP

Type bearer

API key is needed to authorize requests. You can get your API key via the management console.
A Bearer Token is needed to be set in the Authorization header of every API call.
For additional support you can contact us.

Path parameters

ENCRYPTED_STREAM_ID

stringRequired

The encrypted ID of the channel

Query parameters

language

string

category

string

Template category. Possible values: UTILITY, MARKETING, AUTHENTICATION

ExampleUTILITY

status

string

Approval status of the template. Only APPROVED templates are returned.

ExampleAPPROVED

components

object

header

object

Optional header component of the template.

format

string

Header format type. Possible values: TEXT, IMAGE, VIDEO, DOCUMENT.

ExampleTEXT

text

string

Header text content, may include variable placeholders.

ExampleOrder {{1}}

variables

Array

List of variable names mapped to placeholders in the header text.

Example[ "order_number" ]

body

object

Main body content of the template.

text

string

Body text content, may include variable placeholders.

ExampleHi {{1}}, order {{2}} is confirmed.

variables

Array

List of variable names mapped to placeholders in the body text, in order.

Example[ "customer_name", "order_id" ]

footer

object

Optional footer component of the template.

text

string

Static footer text. Does not support variable placeholders.

ExampleReply STOP to unsubscribe

buttons

Array of object

Optional list of buttons attached to the template.

object

type

string

Button type. Possible values: QUICK_REPLY, URL, PHONE.

ExampleQUICK_REPLY

text

string

Display label of the button.

ExampleTrack Order

meta_template_id

string

Unique template ID assigned by Meta.

Example1234567890

pagination

object

Pagination metadata for the current response.

total

integer

Total number of approved templates available for this channel.

Example45

limit

integer

Maximum number of templates requested per page.

Example50

offset

integer

Number of templates skipped. 0 indicates the first page.

Example0

400

Bad request, could not process the input data

{
  "status": "400",
  "description": "Missing parameter templateName",
  "response_time": "2026-08-06T07:51:52.258Z"
}

Expand All

object

status

string

Error status code as string

Example400

description

string

Human-readable description of the error

ExampleMissing parameter templateName

response_time

string

Timestamp of the response

Example2024-08-06T07:51:52.2581942Z

data

Array of object

Array of recipient error details

object

recipient

string

Recipient's phone number

Example9725551234

status

integer

Error status code

Example400

failed

string

Failure reason

ExampleMissing required parameter

401

Unauthorized - The supplied credentials, if any, are not sufficient to access the resource

object

status

integer

Example401

description

string

ExampleUnauthorized

response_time

string (date-time)

Example2026-02-06T07:51:52.258Z

404

Not found - The requested resource is not found

object

status

integer

Example404

description

string

ExampleNot Found

response_time

string (date-time)

Example2026-02-06T07:51:52.258Z

429

Too Many Requests - Too many requests have been made in a short period of time (Throttling)

object

status

integer

Example429

description

string

ExampleToo Many Requests

response_time

string (date-time)

Example2026-02-06T07:51:52.258Z

500

Server Error - The server could not return the representation due to an internal server error

object

status

integer

Example500

description

string

ExampleInternal Server Error

response_time

string (date-time)

Example2026-02-06T07:51:52.258Z

Was this article helpful?