List Templates

Este endpoint permite consultar os templates de mensagens cadastrados na conta do cliente autenticado. Os templates são modelos de mensagens previamente configurados que podem ser utilizados para padronizar comunicações, facilitar integrações e organizar diferentes tipos de envio.

A consulta permite localizar templates específicos por nome ou outros critérios de busca, além de filtrar os resultados por tipo de template e tags associadas. Essa funcionalidade é especialmente útil para aplicações que precisam apresentar uma lista de modelos disponíveis para seleção antes de realizar o envio de mensagens.

Os resultados são retornados de forma paginada, permitindo consultar grandes quantidades de templates sem comprometer o desempenho da integração.

🔐 Restrições

A chave de API deve ser enviada no header x-api-key e precisa estar válida.

O acesso ao endpoint também depende de IP autorizado, conforme as configurações de segurança da conta.

Apenas os templates associados à conta autenticada são considerados na consulta.

O limite máximo de registros por requisição é de 200 templates.

Caso o parâmetro limit não seja informado ou seja menor ou igual a zero, será utilizado o valor padrão de 50 registros.

O parâmetro skip não pode ser negativo. Valores negativos serão automaticamente ajustados para 0.

🧠 Parâmetros de Filtro (Query)

Parâmetro	Tipo	Obrigatório	Descrição
`filter`	string	Não	Texto utilizado para pesquisar templates conforme os critérios de busca disponíveis.
`templateType`	string	Não	Filtra os templates pelo tipo de mensagem associado.
`tag`	string	Não	Filtra os templates pelas tags cadastradas.
`limit`	int	Não	Quantidade máxima de registros retornados por página. Padrão: `50`. Máximo: `200`.
`skip`	int	Não	Quantidade de registros ignorados antes de iniciar a listagem. Padrão: `0`.

🧠 Observações

O endpoint retorna os templates cadastrados para a conta vinculada à chave de API utilizada.

Cada template apresenta as seguintes informações:

Id: identificador único do template.

Name: nome utilizado para identificar o template.

Type: tipo de mensagem associado ao template.

Tags: lista de tags vinculadas ao template.

O campo Tags pode conter até duas tags, sendo omitidos os valores vazios ou não preenchidos.

O retorno inclui a quantidade total de registros encontrados (TotalRecords), permitindo implementar controles de paginação.

A combinação dos filtros permite localizar templates específicos sem a necessidade de consultar toda a base.

Este endpoint é destinado exclusivamente à consulta dos templates, não permitindo criação, edição ou exclusão.

Headers obrigatórios:

🔐 Restrições

🧠 Parâmetros de Filtro (Query)

🧠 Observações

Request

Responses

List Templates

🔐 Restrições#

🧠 Parâmetros de Filtro (Query)#

🧠 Observações#

Request

Responses

🔐 Restrições

🧠 Parâmetros de Filtro (Query)

🧠 Observações