Get Templates

What it does

Lists an application’s WhatsApp templates: cursor pagination + status/category/language filters + name/content search + expand. Data is read fresh directly from Meta (no caching); the app_id is verified to belong to the organization.

Endpoint

GET /public/api/v1/wa/{app_id}/templates

Headers

Authorization

string

required

Secret key in Bearer sk_... format. See Secret Key authentication.

Path parameters

app_id

string

required

Application ID. Must belong to the organization (otherwise 404).

Query parameters

All query parameters are optional.

limit

integer

default:"20"

Maximum records per page. Range 1–100.

after

string

Next-page cursor (the nextCursor from a previous response). Do not pass it on the first request.

before

string

Previous-page cursor (the previousCursor from a response). Cannot be used together with after.

status

string

Status filter. See Template Status.

Response

Type: CursorPagingResult[TemplateResponseModel]. The envelope is { "data": [ ... ], "pagingMetadata": { ... }, "isSuccess": true }.

isSuccess

boolean

true when the request completed successfully.

data

object[]

The list of templates (TemplateResponseModel).

Show template

sourceId

string

The template’s Meta ID.

name

string

Template name.

language

string

Language code.

Examples

Demo 1 — all (default)

GET /public/api/v1/wa/{app_id}/templates
Authorization: Bearer sk_...

{
  "data": [
    { "sourceId": "842802041844912", "name": "order_confirmation", "language": "en", "category": "UTILITY", "status": "APPROVED", "qualityScore": "GREEN", "rejectedReason": "NONE", "parameterFormat": "POSITIONAL" },
    { "sourceId": "1560534655590931", "name": "summer_sale", "language": "en", "category": "MARKETING", "status": "APPROVED", "qualityScore": "YELLOW", "rejectedReason": "NONE", "parameterFormat": "POSITIONAL" }
  ],
  "pagingMetadata": { "hasNext": false, "hasPrevious": false, "pageSize": 2 },
  "isSuccess": true
}

Demo 2 — status filter

GET /public/api/v1/wa/{app_id}/templates?status=APPROVED
Authorization: Bearer sk_...

{
  "data": [
    { "sourceId": "842802041844912", "name": "order_confirmation", "language": "en", "category": "UTILITY", "status": "APPROVED", "qualityScore": "GREEN", "rejectedReason": "NONE", "parameterFormat": "POSITIONAL" }
  ],
  "pagingMetadata": { "hasNext": false, "hasPrevious": false, "pageSize": 1 },
  "isSuccess": true
}

Demo 3 — category + language

GET /public/api/v1/wa/{app_id}/templates?category=UTILITY&language=en
Authorization: Bearer sk_...

{
  "data": [
    { "sourceId": "842802041844912", "name": "order_confirmation", "language": "en", "category": "UTILITY", "status": "APPROVED", "qualityScore": "GREEN", "rejectedReason": "NONE", "parameterFormat": "POSITIONAL" }
  ],
  "pagingMetadata": { "hasNext": false, "hasPrevious": false, "pageSize": 1 },
  "isSuccess": true
}

Demo 4 — search

GET /public/api/v1/wa/{app_id}/templates?search=order
Authorization: Bearer sk_...

{
  "data": [
    { "sourceId": "842802041844912", "name": "order_confirmation", "language": "en", "category": "UTILITY", "status": "APPROVED", "qualityScore": "GREEN", "rejectedReason": "NONE", "parameterFormat": "POSITIONAL" }
  ],
  "pagingMetadata": { "hasNext": false, "hasPrevious": false, "pageSize": 1 },
  "isSuccess": true
}

Demo 5 — with components (expand=components)

GET /public/api/v1/wa/{app_id}/templates?expand=components&status=APPROVED
Authorization: Bearer sk_...

{
  "data": [
    {
      "sourceId": "842802041844912",
      "name": "order_confirmation",
      "language": "en",
      "category": "UTILITY",
      "status": "APPROVED",
      "components": [
        { "type": "HEADER", "format": "TEXT", "text": "Order #{{1}} confirmed", "example": { "headerText": ["12345"] } },
        { "type": "BODY", "text": "Hello {{1}}, your order {{2}} has been confirmed.", "example": { "bodyText": [["John", "#12345"]] } },
        { "type": "FOOTER", "text": "Sent via Connexease" },
        { "type": "BUTTONS", "buttons": [ { "type": "QUICK_REPLY", "text": "Track" } ] }
      ],
      "qualityScore": "GREEN",
      "rejectedReason": "NONE",
      "parameterFormat": "POSITIONAL"
    }
  ],
  "pagingMetadata": { "hasNext": false, "hasPrevious": false, "pageSize": 1 },
  "isSuccess": true
}

Demo 6 — pagination (cursor)

First page:

GET /public/api/v1/wa/{app_id}/templates?limit=2
Authorization: Bearer sk_...

{
  "data": [
    { "sourceId": "842802041844912", "name": "order_confirmation", "language": "en", "category": "UTILITY", "status": "APPROVED", "qualityScore": "GREEN", "rejectedReason": "NONE", "parameterFormat": "POSITIONAL" },
    { "sourceId": "1831871288221211", "name": "order_update", "language": "en", "category": "UTILITY", "status": "PENDING", "qualityScore": "UNKNOWN", "rejectedReason": "NONE", "parameterFormat": "POSITIONAL" }
  ],
  "pagingMetadata": { "nextCursor": "MAZDZDhYbVZ3PQ", "hasNext": true, "hasPrevious": false, "pageSize": 2 },
  "isSuccess": true
}

Next page (nextCursor → after):

GET /public/api/v1/wa/{app_id}/templates?limit=2&after=MAZDZDhYbVZ3PQ
Authorization: Bearer sk_...

{
  "data": [
    { "sourceId": "1560534655590931", "name": "summer_sale", "language": "en", "category": "MARKETING", "status": "APPROVED", "qualityScore": "YELLOW", "rejectedReason": "NONE", "parameterFormat": "POSITIONAL" }
  ],
  "pagingMetadata": { "previousCursor": "MQZDZDhYbVZ3PQ", "hasNext": false, "hasPrevious": true, "pageSize": 1 },
  "isSuccess": true
}

Empty result: "data": [] with "pagingMetadata": { "hasNext": false, "hasPrevious": false, "pageSize": 0 }.

Errors

errors

object

Error details with code, group, and description; isSuccess is false.

Auth / tenant

HTTP	Code	When
401	`ORGANIZATION_SECRET_010`	Secret key is missing.
401	`ORGANIZATION_SECRET_011`	Secret key is invalid.
404	`APPLICATION_004`	`app_id` does not belong to the organization.

Request validation (422)

HTTP	When
422	`limit` outside 1–100; invalid `status`/`category` enum value; invalid `expand` value.

Meta-side (`list_templates_async` — no subcode routing)

HTTP	Code	When
401	`META_034`	Token invalid/expired (190).
403	`META_035`	Permission denied (10 / 200–299).
429	`META_036`	Rate limit (4 / 80007).
400	`META_037`	Invalid parameter (100).
502	`META_004`	General/fallback listing error.

Example error response (429 rate limit):

{ "errors": { "code": "META_036", "group": "...", "description": "Failed to fetch templates. Details: ..." }, "isSuccess": false }

Getting Started

Analytics

Application

Template

What it does

Endpoint

Headers

Path parameters

Query parameters

Response

Examples

Errors

Auth / tenant

Request validation (422)

Meta-side (`list_templates_async` — no subcode routing)

​What it does

​Endpoint

​Headers

​Path parameters

​Query parameters

​Response

​Examples

​Errors

​Auth / tenant

​Request validation (422)

​Meta-side (list_templates_async — no subcode routing)

What it does

Endpoint

Headers

Path parameters

Query parameters

Response

Examples

Errors

Auth / tenant

Request validation (422)

Meta-side (`list_templates_async` — no subcode routing)