# Consultar template

Fonte: https://apiwpp.com/docs/api/templates/consultar-template
Seção: Templates
Atualizado em: 2026-09-28

`GET /connections/{id}/templates/{name}`

Consulta um template da conexão pelo nome e lista as variáveis que o corpo dele usa: são os valores que o envio precisa receber em `variables`. Escopo necessário: `connections:read`.

## Cabeçalhos

| Nome | Obrigatório | Descrição |
| --- | --- | --- |
| `Authorization` | sim | `Bearer <chave de API>`; ou envie a chave em `X-Api-Key`. |

## Parâmetros de caminho

| Nome | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `id` | `string · uuid` | sim | Identificador da conexão (o número). |
| `name` | `string` | sim | Nome do template. A busca não diferencia maiúsculas de minúsculas: o nome é guardado e procurado em minúsculas. |

## Exemplo de requisição

### cURL

```bash
curl https://api.apiwpp.com/connections/$CONNECTION_ID/templates/$NAME \
  -H "Authorization: Bearer $API_KEY"
```

### Node.js

```javascript
const res = await fetch(`https://api.apiwpp.com/connections/${connectionId}/templates/${name}`, {
  headers: {
    Authorization: `Bearer ${API_KEY}`,
  },
})
const data = await res.json()
```

### PHP

```php
$response = Http::withToken($apiKey)
    ->get("https://api.apiwpp.com/connections/{$connectionId}/templates/{$name}");
```

### Python

```python
import requests

response = requests.get(
    f"https://api.apiwpp.com/connections/{connection_id}/templates/{name}",
    headers={"Authorization": f"Bearer {API_KEY}"},
)
```

## Respostas

| Código | Erro | Descrição |
| --- | --- | --- |
| 200 |  | O template (`id`, `connectionId`, `name`, `body`, `createdAt` e `updatedAt`) e `variables`, a lista de variáveis do corpo, cada uma com `name` e `required`. |
| 400 | `FST_ERR_VALIDATION` | O `id` da conexão (que precisa ser um UUID) não segue o schema da operação; `message` diz o que está errado. |
| 401 |  | Sem chave de API, ou com uma chave inválida: desconhecida, revogada ou expirada. O corpo é `{"error": "Unauthorized"}`. |
| 403 |  | A chave não tem o escopo `connections:read`; a mensagem cita o escopo (`This credential lacks the connections:read scope`). |
| 404 |  | A conexão não existe ou não é de quem chama (`Connection not found`): o recurso de outra pessoa responde exatamente como um que não existe. |
| 404 |  | A conexão não tem um template com esse nome (`{"error": "Template not found"}`). |
| 429 |  | Requisições demais deste IP de origem (por padrão, 600 por minuto), ou autenticações com falha demais (por padrão, 20 a cada 5 minutos): espere os segundos de `Retry-After`. Veja [Limites](https://apiwpp.com/docs/referencia/limites). Cabeçalhos: `Retry-After`. |

### 200 OK

```json
{
  "id": "7a0b3c4d-5e6f-4a7b-8c9d-2e3f4a5b6c7d",
  "connectionId": "8b1d4e7f-2c3a-4f5b-9e6d-7a8b9c0d1e2f",
  "name": "confirmacao_consulta",
  "body": "Olá {{nome}}, até amanhã às {{hora}}.",
  "createdAt": "2026-09-20T12:00:00.000Z",
  "updatedAt": "2026-09-20T12:00:00.000Z",
  "variables": [
    {
      "name": "name",
      "required": true
    },
    {
      "name": "time",
      "required": true
    }
  ]
}
```

## Detalhes

`variables` traz cada variável do corpo uma vez, na ordem em que aparece, e todas com `required: true`. As variáveis que só aparecem na legenda da mídia não entram na lista.

Esta resposta não traz a mídia do template; para vê-la, use `GET /connections/{id}/templates`.

Guia: [Enviar mensagens](https://apiwpp.com/docs/guias/enviar-mensagens).
