Listar templates

Retorna os templates de notificação disponíveis para o workspace, com o id usado ao criar notificações.

GEThttps://external-api.arbitralis.com.br/api/external/v1/templates

AutenticaçãoX-API-KEYSíncrono — a resposta já traz o resultado

Retorna os templates de notificação do workspace. O template define o documento que o destinatário visualiza e baixa no portal — o conteúdo jurídico da notificação.

Este é o primeiro endpoint de qualquer integração de notificação: é aqui que você obtém o id a ser enviado em notificationTemplateId.

Query string

statusstringopcionalpadrão PUBLISHED

Filtra por status. Por padrão retorna apenas os publicados — só eles podem ser usados em envios.

valoresDRAFTPUBLISHEDARCHIVED

qstringopcional

Busca parcial pelo nome do template.

pageintegeropcionalpadrão 1

Número da página.

pageSizeintegeropcionalpadrão 20

Itens por página. Máximo 100.

Campos de cada template

Campo	Descrição
`id`	Identificador único. Use em `notificationTemplateId`
`name`	Nome de exibição
`title`	Título do documento da notificação. Pode ser `null`
`status`	`DRAFT`, `PUBLISHED` ou `ARCHIVED`. Apenas `PUBLISHED` pode ser usado em envios
`type`	`BASE` = modelo institucional da Arbitralis; `CUSTOM` = template do seu workspace
`bodyHtml`	Corpo do documento em HTML
`bodyText`	Corpo do documento em texto puro
`variables[]`	Variáveis declaradas pelo template — ver Obter um template
`updatedAt`	Última atualização, em ISO 8601

O template não é escolhido por canal. O mesmo documento serve WhatsApp, e-mail e carta física — os canais carregam apenas o aviso que leva o destinatário até o portal, e o layout deles é fixo do sistema.

Templates BASE e CUSTOM

A listagem traz os modelos institucionais da Arbitralis (type: BASE), disponíveis a todos os workspaces, e os templates personalizados criados pelo seu escritório no painel (type: CUSTOM). Ambos podem ser usados em notificationTemplateId.

Somente templates publicados são utilizáveis

Por padrão a listagem retorna apenas PUBLISHED. Um template em DRAFT existe no painel mas ainda não foi publicado — usá-lo em um envio resulta em erro. Consulte com ?status=DRAFT apenas para diagnóstico.

Código	Causa
`400`	Parâmetros de consulta inválidos
`401`	API key ausente, inválida ou inativa
`429`	Limite de requisições excedido

Requisição

curl -X GET "https://external-api.arbitralis.com.br/api/external/v1/templates" \
  -H "X-API-KEY: arb_live_SUA_CHAVE"

const response = await fetch('https://external-api.arbitralis.com.br/api/external/v1/templates', {
  headers: { 'X-API-KEY': 'arb_live_SUA_CHAVE' },
});

const { data } = await response.json();

for (const template of data.items) {
  const obrigatorias = template.variables.filter((v) => v.mustSendInPayload && v.required);
  console.log(template.name, '→', obrigatorias.map((v) => v.key).join(', ') || 'nenhuma variável');
}

import requests

response = requests.get(
    "https://external-api.arbitralis.com.br/api/external/v1/templates",
    headers={"X-API-KEY": "arb_live_SUA_CHAVE"},
)

templates = response.json()["data"]["items"]

Resposta

{
  "success": true,
  "data": {
    "items": [
      {
        "id": "c7e8f9a0-1b2c-4d3e-8f4a-5b6c7d8e9f0a",
        "name": "Template padrão Arbitralis",
        "title": "Notificação Extrajudicial",
        "status": "PUBLISHED",
        "type": "BASE",
        "bodyHtml": "<p>Prezado(a) {{nome}},</p>",
        "bodyText": "Prezado(a) {{nome}},",
        "variables": [
          {
            "key": "nome",
            "source": "BASE_PLATFORM",
            "required": true,
            "mustSendInPayload": false,
            "origin": "pessoa.nomeCompleto"
          }
        ],
        "updatedAt": "2026-05-04T12:00:00.000Z"
      },
      {
        "id": "4d5e6f7a-8b9c-4d0e-9f1a-2b3c4d5e6f7a",
        "name": "Cobrança — contratos em atraso",
        "title": "Notificação Extrajudicial de Cobrança",
        "status": "PUBLISHED",
        "type": "CUSTOM",
        "bodyHtml": "<p>Prezado(a) {{nome}}, referente ao contrato {{numero_contrato}}...</p>",
        "bodyText": "Prezado(a) {{nome}}, referente ao contrato {{numero_contrato}}...",
        "variables": [
          {
            "key": "nome",
            "source": "BASE_PLATFORM",
            "required": true,
            "mustSendInPayload": false,
            "origin": "pessoa.nomeCompleto"
          },
          {
            "key": "numero_contrato",
            "source": "CUSTOM_FIELD",
            "required": true,
            "mustSendInPayload": true,
            "definitionId": "8d2e3f4a-5b6c-7d8e-9f0a-1b2c3d4e5f6a",
            "type": "TEXT"
          }
        ],
        "updatedAt": "2026-08-01T09:14:22.000Z"
      }
    ],
    "total": 2,
    "page": 1,
    "pageSize": 20,
    "totalPages": 1
  }
}

Listar templates

Campos de cada template

Um template, todos os canais

Somente leitura

Próximo passo

Erros