Get WhatsApp templates

Prev Next
Get
/whatsapp/templates/{ENCRYPTED_STREAM_ID}

This API retrieves a list of all 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 catagory (MARKETING, UTILITY, AUTHENTICATION)
  • Supports comma-separated values

Pagination

Break up large sets of data into smaller, manageable chunks instead of loading everything at once.

  • limit - Determines how many items to fetch per page (e.g., 10 templates), default 50, max 200
  • offset - Determines how many items to skip before starting (e.g., skip the first 20)

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 Meta-approved templates are returned — Meta's quality status is not reflected in the response.
  • The API returns the template business “friendly name” when defined. If not, it defaults to the official WhatsApp business name.

Request Example:

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

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
limit
integer
offset
integer
Responses
200

Operation successful

Expand All
object
status
string
Example200
description
string
ExampleOperation successful
response_time
string

ISO 8601 timestamp of when the response was generated

Example2026-02-02T10:30:00.258Z
data
object

The main response payload.

templates
Array of object

List of Meta-approved WhatsApp message templates.

object
name
string

Template's name

Exampleorder_confirmation
language
string

Language code of the template.

Exampleen
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