List WhatsApp Templates

Prev Next

You can use the WhatsApp Template Management API to receive the list of your WhatsApp templates. You can use this API version if you authenticate requests with an Insider One API key.

All examples below use sample data and payloads for documentation purposes only. Before going live, replace all template names, languages, components, and media handles with values specific to your own integration.

For the V1 template API, authenticate requests with x-ins-auth-key . Public examples below use the Gateway base URL so that your integration stays on a public entrypoint instead of calling internal services.

For the List endpoint:

  • page must be a positive integer.

  • per_page must be between 1 and 100.

  • sort must use the column|direction format, such as createdAt|desc.

Endpoint and Headers

GET https://whatsapp.useinsider.com/api/v1/templates

Headers

Header

Sample Value

Description

X-INS-AUTH-KEY

1a2b3c4d5e6f

This key is required to authorize your request. Refer to Generate API Credentials for WhatsApp Template Management to generate your token.

Content-Type

application/json

This header specifies the media type of the resource.

Body Parameters

Column

Data Type

Required

Description

name

String

Yes

The template name to create.

language

String

Yes

The template locale, such as en_US.

category

String

Yes

The Meta template category.

components

Array[object]

Yes

At least one component is required.

Sample Request

You can filter and paginate the template list with query parameters such as page, per_page, name, statuses[], languages[], qualities[], and sort.

curl --location 'https://whatsapp.useinsider.com/api/v1/templates?page=1&per_page=10&statuses[]=APPROVED&languages[]=en_US&sort=createdAt|desc' \
--header 'x-ins-auth-key: your-api-key'

Sample Response

A successful request returns the following JSON response with a paginated list of your WhatsApp templates

{
  "data": [
    {
      "id": 42,
      "name": "spring_campaign_template",
      "language": "en_US",
      "quality": "PENDING",
      "status": "APPROVED"
    }
  ],
  "current_page": 1,
  "last_page": 1,
  "per_page": 10,
  "total": 1,
  "from": 1,
  "to": 1
}