E-mail de notas
Listar modelos de e-mail
Todos os modelos do integrador, sem paginação; os itens não trazem o corpo.
/openapi/v2/emails/templatestoken, timestamp e sign, veja Autenticação.Lista os modelos do integrador com filtros opcionais por tipo de documento, idioma e situação. Cada item traz os metadados; corpoHtml e variaveisDisponiveis vêm como null e estão em Consultar modelo.
Parâmetros de consulta
tipoDocumento | string | Filtro por tipo de documento |
idioma | string | Filtro por idioma |
ativo | bool | Filtro por situação |
* Campo obrigatório
total | int | Quantidade devolvida |
| array | Modelos |
A lista devolve todos os modelos do integrador, sem paginação, em ordem de criação. Os filtros são exatos e se combinam; sem filtro vêm todos. Para ler o corpo ou a lista de variáveis use Consultar modelo.
Achar o modelo padrão de um tipo
Chame com tipoDocumento=NFe&ativo=true e pegue o item com padrao = true; é o que o envio usa quando templateId é omitido. Se nenhum item tiver padrao = true, o envio sem templateId devolve 10021012.
{"total": 2,"itens": [{"templateId": "2103150000000000001","tipoDocumento": "NFe","idioma": "pt","nome": "NF-e padrão","assunto": "Nota fiscal {{numero}} - {{emitente.nome}}","corpoHtml": null,"padrao": true,"ativo": true,"variaveisDisponiveis": null,"criadoEm": "2026-09-28T12:00:00Z","atualizadoEm": "2026-09-28T12:00:00Z"},{"templateId": "2103150000000000002","tipoDocumento": "NFe","idioma": "en","nome": "NF-e english","assunto": "Invoice {{numero}} from {{emitente.nome}}","corpoHtml": null,"padrao": false,"ativo": true,"variaveisDisponiveis": null,"criadoEm": "2026-09-28T12:05:00Z","atualizadoEm": "2026-09-28T12:05:00Z"}]}
total* | int | Quantidade devolvida |
* | array | Modelos |
* Campo obrigatório
Escolher o modelo por idioma
Só um modelo por tipo é o padrão, independentemente do idioma. Para mandar em outro idioma filtre por idioma e informe o templateId do item escolhido no envio.
{"total": 1,"itens": [{"templateId": "2103150000000000002","tipoDocumento": "NFe","idioma": "en","nome": "NF-e english","assunto": "Invoice {{numero}} from {{emitente.nome}}","corpoHtml": null,"padrao": false,"ativo": true,"variaveisDisponiveis": null,"criadoEm": "2026-09-28T12:05:00Z","atualizadoEm": "2026-09-28T12:05:00Z"}]}
total* | int | Quantidade devolvida |
* | array | Modelos |
* Campo obrigatório
tipoDocumentoTipo de documento
Vale para o filtro e para itens[].tipoDocumento.
| Valores | Significado |
|---|---|
| NFe | NF-e, nota fiscal de mercadorias |
| NFSe | NFS-e, nota fiscal de serviços |
| CTe | CT-e, conhecimento de transporte |
| DCe | DC-e, declaração de conteúdo |
idiomaIdioma do modelo
Vale para o filtro e para itens[].idioma; o idioma define o formato de valores e datas nas variáveis.
| Valores | Significado |
|---|---|
| pt | Português; valores 1.234,56, datas dd/MM/yyyy HH:mm |
| en | Inglês; valores 1,234.56, datas yyyy-MM-dd HH:mm |
| zh | Chinês; valores 1,234.56, datas yyyy-MM-dd HH:mm |
| es | Espanhol; valores 1.234,56, datas dd/MM/yyyy HH:mm |
| Código | HTTP | |
|---|---|---|
| 10021005 | 400 | Tipo de documento não suportado em tipoDocumento; só NFe / NFSe / CTe / DCe. |