Skip to main content
GET
/
{business_account_id}
/
message_templates
List message templates
curl --request GET \
  --url https://api.kapso.ai/meta/whatsapp/{business_account_id}/message_templates \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "1192339204654487",
      "name": "hello_world",
      "previous_category": "ACCOUNT_UPDATE",
      "components": [
        {
          "type": "HEADER",
          "format": "TEXT",
          "text": "Hello World"
        },
        {
          "type": "BODY",
          "text": "Welcome and congratulations!! This message demonstrates your ability to send a message notification from WhatsApp Business Platform's Cloud API. Thank you for taking the time to test with us."
        },
        {
          "type": "FOOTER",
          "text": "WhatsApp Business API Team"
        }
      ],
      "language": "en_US",
      "status": "APPROVED",
      "category": "MARKETING"
    },
    {
      "id": "920070352646140",
      "name": "seasonal_promotion",
      "components": [
        {
          "type": "HEADER",
          "format": "TEXT",
          "text": "Fall Sale"
        },
        {
          "type": "BODY",
          "text": "Hi {{1}}, our Fall Sale is on! Use promo code {{2}} Get an extra 25% off every order above $350!",
          "example": {
            "body_text": [
              [
                "Mark",
                "FALL25"
              ]
            ]
          }
        },
        {
          "type": "FOOTER",
          "text": "Not interested in any of our sales? Tap Stop Promotions"
        },
        {
          "type": "BUTTONS",
          "buttons": [
            {
              "type": "QUICK_REPLY",
              "text": "Stop promotions"
            }
          ]
        }
      ],
      "language": "en_US",
      "status": "APPROVED",
      "category": "MARKETING"
    }
  ],
  "paging": {
    "cursors": {
      "before": "MAZDZD",
      "after": "MjQZD"
    }
  }
}

Authorizations

X-API-Key
string
header
required

Project API key for authentication. This is the recommended authentication method.

Get your API key from the Kapso dashboard under Project Settings > API Keys.

Path Parameters

business_account_id
string
required

WhatsApp Business Account ID

Query Parameters

name
string

Filter by template name

status
enum<string>

Filter by template status

Available options:
APPROVED,
PENDING,
REJECTED
category
enum<string>

Filter by template category

Available options:
AUTHENTICATION,
MARKETING,
UTILITY
language
string

Filter by language code

limit
integer
default:20

Maximum number of results (default 20, max 100)

Required range: 1 <= x <= 100

Response

Successfully retrieved templates

data
object[]
paging
object