List WhatsApp Templates

GET/v1/messages/whatsapp/templates

Returns a paginated list of WhatsApp message templates for a channel. When contact_id is provided, meta.canShowTemplates indicates whether templates may be shown for that contact based on subscription/quota status.

Query Parameters

channel_idstring required

WhatsApp channel MongoDB ObjectId

Example:6a02e728d430cbb990df7e82

namestring

Filter templates by name (partial match)

Example:text

statusstring

Example:APPROVED

contact_idstring

Optional contact ULID used to compute meta.canShowTemplates

Example:01kptye62pxs8pp0xkh6d5vxz2

pageinteger

Example:1

limitinteger

Example:25

Responses

Body

success_codeenum: 200 | 201•Numeric success code matching the HTTP response status. required

Example:200

messagestring required

Example:OK

detailsobject required

dataarray[object] required

_idstring

Example:60f7777777890abcdef12345

workspace_idstring

Example:9e69c76a-683d-44f9-a314-3be15c98aebb

channel_idstring

Example:6a02e728d430cbb990df7e82

namestring

Example:welcome_message

languagestring

Example:en

categorystring

Example:UTILITY

statusenum: PENDING | APPROVED | REJECTED

Example:APPROVED

meta_template_idstring

Example:1234567890

componentsarray[object]

createdAtstring

Example:2026-08-02T18:00:00.000Z

updatedAtstring

Example:2026-08-02T18:00:00.000Z

metaobject

totalItemsinteger

itemCountinteger

per_pageinteger

current_pageinteger

totalinteger

last_pageinteger

message_templates_last_updatedstring or null

canShowTemplatesboolean

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

Request Sample:Shell / cURL

1
2
3
4

curl --request GET \
  --url "https://api-stg.bevatelcloud.com/v1/messages/whatsapp/templates?channel_id=6a02e728d430cbb990df7e82&name=text&status=APPROVED&contact_id=01kptye62pxs8pp0xkh6d5vxz2&page=1&limit=25" \
  --header "Authorization: Bearer <YOUR_API_KEY>" \
  --header "Content-Type: application/json"

Response Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

{
  "success_code": 200,
  "message": "OK",
  "details": {},
  "data": [
    {
      "_id": "60f7777777890abcdef12345",
      "workspace_id": "9e69c76a-683d-44f9-a314-3be15c98aebb",
      "channel_id": "6a02e728d430cbb990df7e82",
      "name": "welcome_message",
      "language": "en",
      "category": "UTILITY",
      "status": "PENDING",
      "meta_template_id": "1234567890",
      "components": [],
      "createdAt": "2026-08-02T18:00:00.000Z",
      "updatedAt": "2026-08-02T18:00:00.000Z"
    }
  ],
  "meta": {
    "totalItems": 0,
    "itemCount": 0,
    "per_page": 0,
    "current_page": 0,
    "total": 0,
    "last_page": 0,
    "message_templates_last_updated": "string",
    "canShowTemplates": true
  }
}