Skip to main content
GET
https://api-ai.zixflow.com
/
api
/
data
/
whatsapp
/
v1
/
{phone_id}
/
templates
Get WhatsApp Templates
curl --request GET \
  --url https://api-ai.zixflow.com/api/data/whatsapp/v1/{phone_id}/templates \
  --header 'x-api-key: <x-api-key>' \
  --header 'x-workspace-id: <x-workspace-id>'
{
  "success": true,
  "message": "Templates retrieved successfully",
  "data": {
    "data": [
      {
        "name": "welcome_message",
        "language": "en",
        "category": "UTILITY",
        "status": "APPROVED",
        "components": []
      },
      {
        "name": "order_confirmation",
        "language": "en_US",
        "category": "MARKETING",
        "status": "APPROVED",
        "components": []
      }
    ],
    "pagination": {
      "size": 25,
      "count": 10,
      "pageSize": 10
    }
  }
}

​
Description

This endpoint allows you to retrieve a paginated list of all WhatsApp templates available for a specific Phone ID. Templates can be filtered by status and include details such as name, category, language, and status.

​
Headers

​
x-api-key
string
required
Your API key for authentication.
​
x-workspace-id
string
required
Your workspace ID for authentication.

​
Path Parameters

​
phone_id
string
required
The unique Phone ID associated with your WhatsApp Business account. You can find this on the Zixflow WhatsApp Settings page or by calling the Get WhatsApp Accounts endpoint.

​
Query Parameters

​
limit
integer
The maximum number of templates to return in the response. Default is 10.
​
offset
integer
The number of templates to skip before starting to return results. Used for pagination. Default is 0.

​
Response

​
success
boolean
Indicates whether the API call was successful.
​
message
string
Success or error message from the API.
​
data
object
The template list response containing:
​
data.data
array
An array of WhatsApp template objects, each containing:
​
data.data[].name
string
The name of the WhatsApp template.
​
data.data[].language
string
The language code of the template (e.g., “en”, “en_US”).
​
data.data[].category
string
The category of the template. Possible values: “MARKETING”, “UTILITY”, “AUTHENTICATION”.
​
data.data[].status
string
The approval status of the template. Possible values: “APPROVED”, “PENDING”, “REJECTED”.
​
data.data[].components
array
An array of template components that define the structure of the template.
​
data.pagination
object
Pagination information containing:
​
data.pagination.size
integer
The total number of templates available.
​
data.pagination.count
integer
The number of templates returned in this response.
​
data.pagination.pageSize
integer
The page size used for this request.
{
  "success": true,
  "message": "Templates retrieved successfully",
  "data": {
    "data": [
      {
        "name": "welcome_message",
        "language": "en",
        "category": "UTILITY",
        "status": "APPROVED",
        "components": []
      },
      {
        "name": "order_confirmation",
        "language": "en_US",
        "category": "MARKETING",
        "status": "APPROVED",
        "components": []
      }
    ],
    "pagination": {
      "size": 25,
      "count": 10,
      "pageSize": 10
    }
  }
}