Templates

Listar templates

Changed on Oct 12, 2026

Templates da organização, em { data, pagination }.

availableForSending: false indica template aprovado em um número que a organização não usa mais. A Meta aprova por conta WhatsApp Business: recrie o template no número ativo.

Permissão: READ.

get/v1/templates

Request

Base URL
https://api.ararahq.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/ararahq/apis/ararahq-api/docs/v1/templates/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

namestring

Nome exato. Devolve no máximo 1 item.

statusstring

Example:APPROVED

Filtra por providerStatus (APPROVED, PENDING, REJECTED, PAUSED, DISABLED), sem diferenciar maiúsculas.

pageinteger

Página, começando em 0.

sizeinteger

Itens por página. Máximo 200.

Headers

X-Waba-Idstring uuid

Restringe o resultado a uma conta WhatsApp Business (WABA) da organização.

Response

Página de templates

Example response

{
  "data": [
    {
      "id": "a7f3c1e2-4b5d-6789-abcd-ef0123456789",
      "name": "pedido_confirmado",
      "formattedName": "pedido_confirmado",
      "category": "UTILITY",
      "originalCategory": "UTILITY",
      "language": "pt_BR",
      "providerName": "GUPSHUP",
      "providerTemplateId": "4c1f0e9a-2b3d-4e5f-8a6b-7c8d9e0f1a2b",
      "providerStatus": "PENDING",
      "rejectionReason": null,
      "availableForSending": true,
      "unavailableReason": null,
      "bodyPreview": "Oi {{1}}, seu pedido {{2}} foi confirmado. Total: R$ {{3}}.",
      "structureJson": {},
      "usageGuide": {
        "message": "Use o objeto 'variables' no envio da mensagem para substituir os placeholders.",
        "endpoint": "POST /v1/messages"
      },
      "variablesSchema": {
        "1": "João",
        "2": "12345",
        "3": "147,90"
      },
      "createdAt": "2026-09-15T14:30:00Z",
      "updatedAt": null
    }
  ],
  "pagination": {
    "page": 0,
    "size": 50,
    "totalElements": 1,
    "totalPages": 1
  }
}

Changes

Oct 12, 2026d576cd28afc0 Revision changes
- info
  api tag Templates added
- info
  api tag templates removed
- info
  added the non-success response with the status
Sep 15, 2026372d8c2e735d Revision changes
- breaking
  removed the enum value APPROVED from the query request parameter status
- breaking
  removed the enum value DISABLED from the query request parameter status
- breaking
  removed the enum value PAUSED from the query request parameter status
- breaking
  removed the enum value PENDING from the query request parameter status
- breaking
  removed the enum value REJECTED from the query request parameter status
- breaking
  the response's body type changed from array to object for status
- breaking
  the response's body type changed from object to no type for status
- breaking
  the response property became optional for the status
- breaking
  the response's property type changed from object to string for status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property / from the response with the status
- breaking
  removed the required property / from the response with the status
- warning
  removed the optional property / from the response with the status
- info
  added the new optional header request parameter X-Waba-Id
- info
  added the new optional query request parameter page
- info
  added the new optional query request parameter size
- info
  added to the response body anyOf list for the response status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status

Operation history (3 revisions)