Skip to main content
GET
/
whatsapp_templates
List WhatsApp templates
curl --request GET \
  --url https://app.kapso.ai/api/v1/whatsapp_templates \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "template-123abc",
      "name": "appointment_reminder",
      "language_code": "en_US",
      "category": "UTILITY",
      "status": "approved",
      "content": "Hello {{1}}, your appointment is confirmed for {{2}}.",
      "parameter_count": 2,
      "business_account_id": "123456789012345",
      "whatsapp_config_ids": [
        "config-123abc",
        "config-456def"
      ],
      "components": [
        {
          "type": "HEADER",
          "format": "TEXT",
          "text": "<string>",
          "example": {},
          "buttons": [
            {}
          ]
        }
      ],
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 123,
    "per_page": 123,
    "total_pages": 123,
    "total_count": 123
  }
}

Authorizations

​
X-API-Key
string
header
required

API key required for all endpoints

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
per_page
integer
default:20
Required range: 1 <= x <= 100
​
customer_id
string<uuid>

Filter templates by customer ID

​
q[name_cont]
string

Filter templates by name (contains)

​
q[language_code_eq]
string

Filter templates by exact language code match

​
q[category_eq]
enum<string>

Filter templates by category

Available options:
MARKETING,
UTILITY,
AUTHENTICATION
​
q[status_eq]
enum<string>

Filter templates by status

Available options:
draft,
submitted,
approved,
rejected,
disabled
​
q[customer_id_eq]
string<uuid>

Filter templates by customer ID (Ransack syntax)

​
business_account_id
string

Filter templates by WhatsApp Business Account ID

​
q[business_account_id_eq]
string

Filter templates by WhatsApp Business Account ID (Ransack syntax)

​
whatsapp_config_id
string<uuid>

Filter templates by WhatsApp configuration ID

​
q[whatsapp_config_id_eq]
string<uuid>

Filter templates by WhatsApp configuration ID (Ransack syntax)

Response

A list of WhatsApp templates

​
data
object[]
​
meta
object
⌘I