List WhatsApp Templates API

Retrieve the WhatsApp message templates configured for your business. Use this endpoint to inspect template approval status, language, and components, and to find approved templates for campaign creation.

Endpoint

GET https://client-api.e-so.in/engage/v1/wa-templates

Authentication is required. Results are scoped to the business associated with the access token. The endpoint supports pagination and selective field retrieval.

Authentication

Provide a business access token using either header:

If both headers are supplied, Authorization takes precedence. A missing, invalid, or expired token returns 401 Unauthorized.

Request parameters

This endpoint does not require a request body.

Pagination defaults, maximum page size, and behavior when fields is omitted are not specified in the supplied reference.

Available fields

id, business_id, name, category, status, template_type, language, wa_template_id, template_file, created_at, quality_score, rejected_reason, components, description

An unsupported field name returns 422.

Example request

curl "https://client-api.e-so.in/engage/v1/wa-templates?page=1&limit=20&fields=id,name,category,status,language,components" \
  -H "Authorization: Bearer YOUR_TOKEN"

Successful response

HTTP status: 200 OK

The following example corresponds to the fields selected above:

{
  "status": 200,
  "success": true,
  "message": "success",
  "payload": {
    "data": [
      {
        "id": 123,
        "name": "order_confirmation",
        "category": "MARKETING",
        "status": "APPROVED",
        "language": "en",
        "components": [
          {
            "type": "BODY",
            "text": "Hello {{1}}"
          }
        ]
      }
    ],
    "meta": {
      "total": 18,
      "per_page": 20,
      "current_page": 1,
      "last_page": 1,
      "first_page": 1,
      "first_page_url": "/?page=1",
      "last_page_url": "/?page=1",
      "next_page_url": null,
      "previous_page_url": null
    }
  }
}

Response structure

Pagination metadata

Retrieve additional pages using the page query parameter. Client-side filtering applies only to the page retrieved; paginate through all results if you need every approved template.

Errors

Rate limiting applies through defaultRateLimiter. Numerical limits, retry timing, and error response schemas are not specified in the supplied reference.

Code examples

JavaScript

async function listApprovedTemplates(token, page = 1) {
  const params = new URLSearchParams({
    page: String(page),
    limit: "20",
    fields: "id,name,status,language,components",
  });

  const response = await fetch(
    `https://client-api.e-so.in/engage/v1/wa-templates?${params}`,
    { headers: { Authorization: `Bearer ${token}` } }
  );

  if (!response.ok) {
    throw new Error(`Template request failed: HTTP ${response.status}`);
  }

  const body = await response.json();
  return {
    templates: body.payload.data.filter(
      (template) => template.status === "APPROVED"
    ),
    meta: body.payload.meta,
  };
}

Python

Requires the requests package.

import requests


def list_approved_templates(token, page=1):
    response = requests.get(
        "https://client-api.e-so.in/engage/v1/wa-templates",
        params={
            "page": page,
            "limit": 20,
            "fields": "id,name,status,language",
        },
        headers={"Authorization": f"Bearer {token}"},
        timeout=30,
    )
    response.raise_for_status()
    payload = response.json()["payload"]
    return {
        "templates": [
            template for template in payload["data"]
            if template["status"] == "APPROVED"
        ],
        "meta": payload["meta"],
    }

Both examples return approved templates from one page and retain pagination metadata for subsequent requests.

Use a template in a campaign

1. Request templates with at least id,name,status in fields.
2. Choose a template whose status is APPROVED.
3. Retrieve its variables using GET /engage/v1/wa-templates/{templateId}/variables.
4. Use those variables to build the campaign's column_mappings.
5. Create the campaign using POST /engage/v1/campaigns, passing the selected template's id as the campaign's wa_template_id.

The campaign's wa_template_id uses the template record's id, as described in the supplied reference. Do not substitute the template record's separately named wa_template_id field.

Related endpoints

Support

When contacting support, include the request URL and query parameters, the response status and message, and the UTC timestamp. Redact access tokens and other credentials.

Documentation prepared from the supplied API reference. Endpoint behavior has not been independently tested.