API Pública LegalMail — Guia Completo de Integração

A API pública da LegalMail permite que sistemas externos se integrem à plataforma para gerenciar processos, petições, partes, protocolos, notificações e muito mais — tudo de forma programática.

Este artigo reúne toda a documentação necessária para utilizar a API, incluindo autenticação, limites de uso, boas práticas e a referência completa de todos os endpoints disponíveis.

Todas as requisições exigem o parâmetro api_key na query string. A chave de API identifica o workspace e pode ser obtida no menu Integrações dentro da plataforma LegalMail.

Exemplo:

Se a chave não for informada ou for inválida, a API retornará 401 — API key not provided ou 404 — API key not found.

A API possui um limite de 30 requisições por minuto. Requisições que ultrapassem esse limite recebem o status HTTP 429 — Too many requests.

⚠️ Política anti-polling:

Recomendações para evitar penalizações:

Todos os endpoints descritos neste artigo utilizam esta URL como prefixo.

Retorna todos os processos vinculados ao workspace.

Parâmetros de query:

Exemplo de resposta (200):

Retorna os dados completos de um processo específico. Informe apenas um dos parâmetros numero_processo ou idprocesso.

Parâmetros de query:

* Informe um ou outro, não ambos.

Campos retornados na resposta (200):

O objeto retornado inclui: idprocessos, numero_processo, hash_processo, foro, last_import, valor_causa, data_distribuicao, data_prazo, poloativo_nome, polopassivo_nome, nome_classe, abreviatura_classe, inbox_atual, juizo, tribunal, processo_tema, sistema_tribunal.

Exclui o processo e encerra o monitoramento de intimações. Opcionalmente, bloqueia o processo para impedir reimportação automática.

Body (JSON):

Um mesmo processo pode ser excluído no máximo 3 vezes. Após atingir esse limite, a API retorna erro.

Alterna o estado de arquivo do processo. Quando arquivado, o prazo é removido; ao desarquivar, o processo retorna ao inbox de entrada.

Body (JSON):

Vincula um usuário como responsável pelo processo.

Body (JSON):

Retorna as movimentações classificadas como autos vinculadas a um processo.

Parâmetros de query:

Exemplo de resposta (200):

Retorna a URL pré-assinada (S3) do documento de uma movimentação específica, pronta para download.

Parâmetros de query:

Exemplo de resposta (200):

Os campos personalizados permitem adicionar informações extras aos processos, como origem do cliente, datas internas, etc.

Retorna o catálogo de campos personalizados ativos do workspace (sem valores por processo).

Retorna os campos personalizados preenchidos para um processo específico.

Cria ou atualiza campos personalizados. Se a definição (nome) não existir no workspace, ela é criada automaticamente.

Body (JSON):

Tipos disponíveis: texto, numero, data, email, booleano. Quando ausente, assume texto.

Atualiza valores de campos já definidos no workspace. Identifique o campo por id ou por nome.

Body (JSON):

Remove uma definição de campo personalizado e todos os vínculos com processos (cascade).

O parâmetro fk_campo_personalizado pode ser enviado na query string ou no body JSON.

Permite solicitar a importação de processos para o workspace, de forma avulsa ou em lote.

Exemplo de resposta:

Identifica o tribunal pelo número CNJ e retorna os sistemas cadastrados.

Exemplo de resposta:

Body (JSON):

Se o número estiver no padrão CNJ, ele deve corresponder ao tribunal informado. Caso já exista um pedido idêntico pendente, o item é retornado como warning sem duplicar.

Informe hash para buscar um lote inteiro ou numero para buscar por processo específico.

Body (JSON):

Cancela pedidos com status 0 ou 10 (pendentes) do lote informado.

Solicita a sincronização de novos autos do processo. A chamada é recusada se já houver atualização pendente ou se houve solicitação nos últimos 3 dias.

Body (JSON):

Enfileira a geração de um PDF único com todos os autos. O processamento ocorre em segundo plano.

Body (JSON):

Exemplo de resposta (200):

É permitido apenas um download completo a cada 3 dias por processo.

O campo job_id é opcional — se ausente, retorna o último job válido do processo. Quando concluído, o campo output_url traz a URL do PDF pronto para download.

Cria uma ou mais petições iniciais vinculadas ao workspace.

Body (JSON) — aceita objeto único ou array:

Fluxo recomendado após criar:

Retorna os dados normalizados da petição, incluindo todos os campos preenchidos e o payload original.

Permite editar todos os dados do processo associado à petição. Os mesmos campos aceitos na criação são validados. Quando tipo_distribuicao for Por dependência, é obrigatório enviar processo_referencia (formato CNJ) e fundamento_legal.

Remove a petição e o processo criado junto a ela.

Todos os endpoints abaixo recebem api_key e idpeticoes como parâmetros obrigatórios e retornam listas de opções disponíveis com base nos dados já preenchidos na petição:

Body (JSON):

Fluxo completo recomendado:

Retorna dois arrays: intimacoes_prazo_fechado e intimacoes_prazo_aberto, cada um com os campos idintimacoes, data_intimacao, hora_intimacao, tipo_intimacao, tipo_prazo e texto_intimacao.

Parâmetros de query:

Body (JSON, opcional):

O campo intimacoes permite marcar intimações como cumpridas ao protocolar.

Estes endpoints são usados tanto para petições iniciais quanto intermediárias.

Upload do PDF principal da petição. Somente arquivos PDF são aceitos.

Parâmetros de query: api_key, idpeticoes, idprocessos

Body: multipart/form-data com o campo file contendo o PDF.

Upload de documentos anexos à petição. Somente PDF.

Parâmetros de query: api_key, idpeticoes, fk_documentos_tipos

Body: multipart/form-data com o campo file.

O fk_documentos_tipos deve corresponder a um tipo retornado pelo endpoint abaixo.

Retorna as peças disponíveis para a petição (ex: { "idpecas": 1, "nome": "Peca A" }).

Exemplo de resposta:

Body (JSON):

Retorna um inteiro representando o código de status da petição.

Retorna as partes cadastradas no workspace com todos os dados cadastrais: nome, documento (CPF/CNPJ), e-mail, celular, endereço completo, dados pessoais, profissão, entre outros.

* É obrigatório informar ao menos nome ou documento.

Campos obrigatórios no body: polo (ativo ou passivo), nome, documento.

Regras de validação:

Campos de órgão de vinculação (nome_orgao_vinculacao, cnpj_orgao_vinculacao, email_orgao_vinculacao): aceitos somente para polo passivo com personalidade "Autoridade Coatora" em sistemas PJe (exceto TRF-1 e TRF-5).

Campos obrigatórios: id, polo, nome, documento. Campos não enviados permanecerão inalterados. Não é possível alterar o polo de uma parte já criada.

Body (JSON):

Retorna a lista de protocolos com suporte a filtros e paginação.

Filtros disponíveis (todos opcionais):

Exemplo de resposta (200):

O campo mensagem_pendencia é preenchido apenas quando o status for Com pendências.

Registra uma URL para receber notificações automáticas sempre que houver atualização nos processos do workspace.

Parâmetros de query:

Payload de notificação de intimação/movimentação:

Ao receber novas intimações, o LegalMail enviará um POST para o endpoint cadastrado com o seguinte formato:

Em cada movimentação, o campo tipo indica o formato do conteúdo e pode ser text ou pdf.

Payload de notificação de protocolo finalizado:

Exemplo de resposta:

Importante: Senhas devem ser enviadas criptografadas em MD5.

Campos obrigatórios: nome, email, senha (MD5), perfil (operador ou administrador), cpf, rg, orgao_expedidor, data_nascimento, telefone.

Campos opcionais: oab (6 dígitos), uf (2 letras maiúsculas).

Regras de validação:

Campo obrigatório: idusuarios. Somente os campos enviados serão alterados.

Body (JSON):

O gerador de documentos permite criar documentos com base em modelos pré-configurados no LegalMail (via Google Docs), substituindo variáveis por valores dinâmicos.

Retorna os modelos disponíveis com suas variáveis configuradas:

Body (JSON):

Os nomes das variáveis no objeto variaveis devem corresponder exatamente aos nomes cadastrados no modelo (aqueles inseridos no texto como {{Nome da variavel}}).

Body: { "id": 10 }

Body: { "idgerador_documentos_modelos": 1 }

Documentação baseada na especificação OpenAPI v1.0.0 da LegalMail Public API.