Listar templates HSM (a tela Templates › WhatsApp oficial)

Lista paginada dos templates do tenant — é o que popula a tela
Configurações › Templates › WhatsApp oficial.

O retorno é o envelope { items, total, offset, limit } (não é array puro).
Cada item traz o conteúdo completo do HSM em content.components, então dá pra
renderizar o preview sem uma segunda chamada.

Mapa tela → campo:

Coluna da tela	Campo
Nome	`name`
Categoria	`content.category`
WABA	`wabaName`
Criado em	`createdAt`
Atualizado em	`updatedAt`
Qualidade	`analytics.quality_score`
Status	`status`

Use pra:

Montar a listagem de modelos aprovados antes de disparar campanha

Achar o id de um template pra usar em envio ativo

Auditar o que está rejected / in-review na Meta

Para a tela de WhatsApp oficial, filtre sempre por
channel=whatsapp&contentType=hsm — sem isso vêm também templates de RCS e SMS.

Este endpoint também atende RCS. Use channel=rcs e o contentType
correspondente (text, rich-card ou carousel) — o formato do content muda
conforme o tipo. Veja Configurações › Templates › RCS.

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Respostas

🟢200OK

application/json

Página de templates.

Bodyapplication/json

Exemplo

{
    "items": [
        {
            "id": "d41a8c76-3b52-4e09-9f18-6c7b204ea351",
            "name": "continuacao_conversa",
            "description": null,
            "companyToken": "9f3c1a7e5d2b48c0a1e6f70b2c4d8e91",
            "externalId": "600000000000001",
            "appId": "800000000000001",
            "wabaId": "900000000000001",
            "status": "active",
            "channel": "whatsapp",
            "contentType": "hsm",
            "content": {
                "type": "hsm",
                "category": "marketing",
                "language": "pt_BR",
                "components": [
                    {
                        "text": "Olá! Tudo bem?\n\nMeu nome é {{agente}} e faço parte da equipe.\n\nA partir de agora, vou dar continuidade ao seu atendimento.\n\nPodemos continuar a conversa?",
                        "type": "body",
                        "variables": [
                            {
                                "example": "João",
                                "parameterName": "agente"
                            }
                        ]
                    }
                ],
                "parameterFormat": "named"
            },
            "variables": [
                {
                    "type": "body",
                    "default": "João",
                    "parameterName": "agente"
                }
            ],
            "reason": null,
            "analytics": {},
            "activeAt": "2026-07-30T20:39:03.404Z",
            "archivedAt": null,
            "deletedAt": null,
            "inactiveAt": null,
            "inReviewAt": null,
            "rejectedAt": null,
            "flaggedAt": null,
            "pausedAt": null,
            "lockedAt": null,
            "inAppealAt": null,
            "limitExceededAt": null,
            "pendingDeletionAt": null,
            "reinstatedAt": null,
            "createdAt": "2026-07-30T20:30:31.938Z",
            "updatedAt": "2026-07-30T20:39:03.406Z",
            "wabaName": "Atendimento Comercial"
        },
        {
            "id": "f0928d15-6a34-4b7c-8e51-93df20a6b478",
            "name": "boletim_mensal",
            "description": null,
            "companyToken": "9f3c1a7e5d2b48c0a1e6f70b2c4d8e91",
            "externalId": "600000000000002",
            "appId": "800000000000001",
            "wabaId": "900000000000002",
            "status": "active",
            "channel": "whatsapp",
            "contentType": "hsm",
            "content": {
                "type": "hsm",
                "category": "marketing",
                "language": "pt_BR",
                "components": [
                    {
                        "type": "header",
                        "example": "4::aW1hZ2UvanBlZw==:EXEMPLO_HANDLE_DE_MIDIA_DA_META",
                        "subType": "image",
                        "fileName": "boletim.jpg"
                    },
                    {
                        "text": "No boletim deste mês reunimos conteúdos estratégicos para apoiar decisões que impactam a sua operação.\n⭐ Acesse agora os destaques.",
                        "type": "body"
                    },
                    {
                        "type": "buttons",
                        "buttons": [
                            {
                                "url": "https://redirect.digitalk.com.br/r/{{1}}",
                                "text": "Acessar o Boletim",
                                "type": "url",
                                "example": "https://redirect.digitalk.com.br/r/exemplo",
                                "redirectId": "7e21b940-8c53-4f6a-b018-2d5934ea7c61"
                            }
                        ]
                    }
                ],
                "parameterFormat": "named"
            },
            "variables": [
                {
                    "type": "header",
                    "default": "https://storage.example.com/ms-channels-gateway/exemplo/media.jpeg",
                    "subType": "image"
                },
                {
                    "type": "button",
                    "index": 0,
                    "default": "https://redirect.digitalk.com.br/r/",
                    "subType": "url",
                    "redirectId": "7e21b940-8c53-4f6a-b018-2d5934ea7c61"
                }
            ],
            "reason": null,
            "analytics": {},
            "activeAt": "2026-07-30T13:23:34.823Z",
            "archivedAt": null,
            "deletedAt": null,
            "inactiveAt": null,
            "inReviewAt": null,
            "rejectedAt": null,
            "flaggedAt": null,
            "pausedAt": null,
            "lockedAt": null,
            "inAppealAt": null,
            "limitExceededAt": null,
            "pendingDeletionAt": null,
            "reinstatedAt": null,
            "createdAt": "2026-07-29T14:11:31.612Z",
            "updatedAt": "2026-07-30T13:23:34.823Z",
            "wabaName": "Marketing"
        },
        {
            "id": "a35c7e10-42b8-4d96-8071-5eb3f9ca2d64",
            "name": "pesquisa_satisfacao",
            "description": null,
            "companyToken": "9f3c1a7e5d2b48c0a1e6f70b2c4d8e91",
            "externalId": "600000000000003",
            "appId": "800000000000001",
            "wabaId": "900000000000001",
            "status": "active",
            "channel": "whatsapp",
            "contentType": "hsm",
            "content": {
                "id": "600000000000003",
                "name": "pesquisa_satisfacao",
                "type": "hsm",
                "category": "marketing",
                "language": "pt_BR",
                "components": [
                    {
                        "text": "Obrigado por escolher a {{1}}. Avaliando seu último atendimento em {{2}}, numa escala de 0 a 10, o quanto você nos indicaria a um amigo?",
                        "type": "body",
                        "variables": [
                            "Empresa Exemplo",
                            "São Paulo"
                        ]
                    },
                    {
                        "type": "buttons",
                        "buttons": [
                            {
                                "text": "Sim",
                                "type": "quick_reply",
                                "index": 0
                            },
                            {
                                "text": "Não",
                                "type": "quick_reply",
                                "index": 1
                            }
                        ]
                    }
                ],
                "parameterFormat": "positional"
            },
            "variables": [
                {
                    "type": "body",
                    "default": "Empresa Exemplo"
                },
                {
                    "type": "body",
                    "default": "São Paulo"
                }
            ],
            "reason": null,
            "analytics": {
                "quality_score": "UNKNOWN"
            },
            "activeAt": "2026-07-20T12:55:41.548Z",
            "archivedAt": null,
            "deletedAt": null,
            "inactiveAt": null,
            "inReviewAt": null,
            "rejectedAt": null,
            "flaggedAt": null,
            "pausedAt": null,
            "lockedAt": null,
            "inAppealAt": null,
            "limitExceededAt": null,
            "pendingDeletionAt": null,
            "reinstatedAt": null,
            "createdAt": "2025-10-25T12:14:31.606Z",
            "updatedAt": "2026-07-20T12:55:41.551Z",
            "wabaName": "Atendimento Comercial"
        }
    ],
    "total": 48,
    "offset": 0,
    "limit": 8
}

🟠401Não Autorizado

🟠403Proibido

🔴500Erro Interno

Listar templates HSM (a tela Templates › WhatsApp oficial)

Requisição

Códigos de solicitação

Respostas