Templates

Listar modelos

GEThttps://api.picchat.com.br/v1/templates

Lista os modelos de mensagem da conta (excluídos ficam de fora), ordenados por updated_at, com os componentes no formato da Meta (HEADER, BODY, FOOTER, BUTTONS, CAROUSEL, LIMITED_TIME_OFFER). Filtra por canal, status, tipo, categoria e texto.

Autenticação: Bearer tokenPermissão: Templates › ver

Parâmetros de consulta (query)

pageintegerpadrão 1
Página, começando em 1. Valor ausente, inválido ou menor que 1 vira 1.
limitintegerpadrão 20
Itens por página. Padrão 20, máximo 100: acima disso é reduzido para 100 sem erro; valor inválido ou menor que 1 vira 20.
channel_idstring (uuid)
Só modelos deste canal.
statusstring
Status de aprovação.
typestring
Tipo/canal do modelo.
categorystring
Categoria na Meta.
searchstring
Busca parcial em nome, nome interno e corpo, sem diferenciar maiúsculas.
orderstringpadrão "desc"
Direção da ordenação por `updated_at`. Qualquer outro valor usa o padrão.

Respostas

200OK

itemsarray<Template>obrigatório
Registros da página.
items[].idstring (uuid)obrigatório
ID do modelo.
items[].namestringobrigatório
Nome exibido.
items[].internal_namestringobrigatório
Nome interno (o registrado na Meta).
items[].typestringobrigatório
Tipo/canal do modelo.
whatsapp_litewhatsappsmsemailwebhookrcs
items[].statusstringobrigatório
Status de aprovação.
APPROVEDIN_APPEALPENDINGREJECTEDPENDING_DELETIONDELETEDDISABLEDPAUSEDLIMIT_EXCEEDEDARCHIVED
items[].categorystring | nullobrigatório
Categoria na Meta.
ACCOUNT_UPDATEPAYMENT_UPDATEPERSONAL_FINANCE_UPDATESHIPPING_UPDATERESERVATION_UPDATEISSUE_RESOLUTIONAPPOINTMENT_UPDATETRANSPORTATION_UPDATETICKET_UPDATEALERT_UPDATEAUTO_REPLYTRANSACTIONALOTPUTILITYMARKETINGAUTHENTICATIONSERVICEnull
items[].languagestring | nullobrigatório
Idioma (ex.: pt_BR).
items[].quality_scorestring | nullobrigatório
Qualidade do modelo na Meta.
GREENYELLOWREDUNKNOWNnull
items[].bodystring | nullobrigatório
Texto do corpo, com variáveis {{n}}.
items[].HEADERanyobrigatório
Componente de cabeçalho no formato da Meta (JSON livre, pode ser null).
items[].BODYanyobrigatório
Componente de corpo no formato da Meta (JSON livre, pode ser null).
items[].FOOTERanyobrigatório
Componente de rodapé no formato da Meta (JSON livre, pode ser null).
items[].BUTTONSanyobrigatório
Botões no formato da Meta (JSON livre, pode ser null).
items[].CAROUSELanyobrigatório
Cartões de carrossel no formato da Meta (JSON livre, pode ser null).
items[].LIMITED_TIME_OFFERanyobrigatório
Oferta por tempo limitado no formato da Meta (JSON livre, pode ser null).
items[].ex_idstring | nullobrigatório
ID do modelo na Meta.
items[].reasonstring | nullobrigatório
Motivo da rejeição, quando houver.
items[].created_atstring (date-time)obrigatório
Criação.
items[].updated_atstring (date-time)obrigatório
Última atualização.
items[].channelsobject | nullobrigatório
Canal do modelo.
items[].channels.idstring (uuid)obrigatório
ID do canal.
items[].channels.namestringobrigatório
Nome do canal.
items[].channels.typestringobrigatório
Tipo do canal.
whatsappwhatsapp_litesmsemailwebhookchatinstagramrcs
totalintegerobrigatório
Total de registros que casam com os filtros (todas as páginas).
pageintegerobrigatório
Página devolvida (começa em 1).
limitintegerobrigatório
Itens por página efetivamente usados (1–100).
pagesintegerobrigatório
Total de páginas: `max(1, ceil(total / limit))`. Nunca é 0, mesmo sem resultados.

403Acesso negado: usuário do token sem a permissão da rota (`permission_denied`) ou token não ligado a um usuário ativo (`token_without_user`) — para token de integração da conta isso só é aplicado quando `access.enforced` é true (veja GET /v1/me); token pessoal e JWT de sessão são sempre verificados; `account_id` na query diferente da conta do token; conta do tipo INFRA.

498Token ausente, inválido, de outra finalidade (ex.: token do canal chat) ou revogado. Note o status não padrão 498.