List Templates

This request retrieves a list of existing WhatsApp templates .

GET https://api-v7.express-chat.com/whatsapp-automation/templates/get-facebook-templates/{botId}?search={search}

Query Parameters

Name
Description

botId

The ID of the bot whose templates you want to retrieve.

search

The template name to search for. The response will include only templates whose names contain the specified search value.

Headers

Name
Value

Content-Type

application/json

Authorization

Bearer <token>

authtype

Key

Responses

chevron-right200hashtag
{
  "success": true,
  "data": [
    {
      "_id": "6912ee67c8a7cb954e0ced96",
      "_user": "5fed38e56fb193dcc6c933f5",
      "_bot": "690823e884ec34b46d906126",
      "templateId": "1162333778785556",
      "configuration": {
        "name": "professional_reusable",
        "category": "MARKETING",
        "language": "en",
        "components": [
          {
            "type": "HEADER",
            "format": "TEXT",
            "text": "Hi users"
          },
          {
            "type": "BODY",
            "text": "I hope you’re doing well.\nI’m writing to [purpose β€” e.g., request approval / share an update / ask for information\n\nWhat you want the recipient to do β€” be specific and include deadline if any"
          },
          {
            "type": "FOOTER",
            "text": "[Key point 1 β€” what happened or what you need]  [Key point 2"
          },
          {
            "type": "BUTTONS",
            "buttons": [
              {
                "type": "QUICK_REPLY",
                "text": "Thanks"
              }
            ]
          }
        ]
      },
      "status": "APPROVED",
      "headerMediaUrl": "",
      "triggerConfig": [],
      "carousalHeaderUrls": [],
      "templateType": "REGULAR",
      "createdAt": "2025-11-11T08:05:59.522Z",
      "updatedAt": "2025-11-11T08:05:59.522Z",
      "__v": 0
    },
  ]
}

Response Fields

Root Level

Field
Type
Description

success

Boolean

Indicates whether the API request was successful.

data

array

An array of WhatsApp template objects retrieved for the specified bot.

data[] (Template Array)

Field
Type
Description

_id

String

ID of the template record in the system.

_user

String

ID of the user who owns the template.

_bot

String

ID of the bot linked to this template.

templateId

String

WhatsApp (Meta) template ID.

configuration

Object

Template details and structure configuration.

status

String

Current approval status of the template, determined by Meta (APPROVED, PENDING, REJECTED).

headerMediaUrl

String

URL of the media used in the template's header (if applicable).

triggerConfig

Array

Trigger rules linked to the template (if any).

carousalHeaderUrls

Array

Array of carousel header media URLs (if applicable).

templateType

String

Type of template (e.g., REGULAR).

createdAt

String (ISO Date)

Timestamp when the template was created.

updatedAt

String (ISO Date)

Timestamp when the template was updated.

__v

Number (Integer)

Internal versioning field.

configuration (Object)

Field
Type
Description

name

String

The name of the template as registered with WhatsApp (Meta). This value can be used as the search parameter when retrieving the templates.

category

String

Template category (MARKETING, UTILITY, AUTHENTICATION).

language

String

Language code of the template (e.g., en).

components

Array

Message components that define the template structure.

components[]

Field
Type
Description

type

String

Component type (HEADER, BODY, FOOTER, BUTTONS, CALL_PERMISSION_REQUEST).

format

String

Header format (TEXT, IMAGE, VIDEO) - applicable to HEADER components only (if any).

text

String

Components text content

buttons

Array

List of set interactive buttons - applicable to BUTTONS components only (If any)

example

Object

Sample values set for dynamic variables during template creation (if any).

buttons[] (Objects)

Field
Type
Description

type

String

Button type (e.g., QUICK_REPLY).

text

String

Button display text.

chevron-right400 - bad requesthashtag

The <token> being used is incorrect.

{
  "success": false,
  "message": "Argument passed in must be a single String of 12 bytes or a string of 24 hex characters",
  "code": 400
}

chevron-right401 - unauthorizedhashtag

Your request is missing the authtype: Key header

{
  "success": false,
  "message": "jwt malformed",
  "code": 401
}

Sample requests

Replace <token> in the below example requests with your valid Bearer token.

❓ Got any questions?

If you have any questions, you can look into our repository of FAQs, most likely, you will find your answer here, If not, write us at [email protected].

Last updated