Listar processos do escritório
GET · API de Integração v2
/v2/processosListar processos
Devolve a página de processos do seu escritório. É a coleção do recurso — diferente de
GET /v2/processos/opcoes, que existe só para preencher um campo de seleção.
Campos: os mesmos da rota de seleção (id, numero,
tribunal, grau, partes) mais encerrado e
monitoramentoAtivo — a captura automática do tribunal. Os dois estados
são independentes: um processo pode estar encerrado e monitorado ao mesmo tempo.
monitoramentoAtivo é o mesmo nome aceito no cadastro/edição, então o valor lido
aqui pode ser reenviado sem tradução.
Cada um dos dois tem o filtro de mesmo nome — o que a listagem devolve é exatamente o que o filtro seleciona.
Tribunal: tribunal vem sempre preenchido — todo processo aponta para uma
linha de tribunais, inclusive quando não há tribunal de fato: nesses casos vem
Sem Tribunal, ou Processo Administrativo no administrativo.
grau pode vir nulo, porque não é toda linha de tribunais que o define
— o administrativo é um desses casos.
Nulos: partes vem nulo em processo que nunca foi capturado.
Ordenação: por número do processo, crescente.
Escopo: só processos não excluídos do escritório do token.
Filtros
Omitir um filtro não filtra por ele — nenhum tem valor padrão que restrinja o
resultado. Sem nenhum parâmetro, a rota devolve todos os processos do escritório. Se a tela
abre pré-filtrada por ativos, é ela que envia encerrado=false.
| Filtro | Efeito |
|---|---|
q | Barra de pesquisa — casa pelo começo do número do processo. Vazio ou omitido, não filtra. |
encerrado | true só encerrados;
false só não encerrados; omitido, os dois. |
monitoramentoAtivo | true só com captura
automática ligada; false só desligada; omitido, os dois. |
cpfCnpjCliente | CPF/CNPJ exato, com ou sem máscara, da pessoa vinculada ao processo como cliente. |
Filtros combinam por E. ?encerrado=true&monitoramentoAtivo=true devolve
os processos que são encerrados e monitorados — são eixos independentes, não opções de
uma mesma lista. A busca entra na mesma conjunção:
?q=2024&encerrado=false procura "2024" dentro dos não encerrados.
Sobre a busca (q)
Casa pelo começo do número, não por trecho no meio. 1011214 acha o processo
1011214-58.2024.8.26.0477; 0477 (o final) e 2024 (o ano, no
meio) não acham nada. É uma escolha deliberada: buscar por trecho arbitrário impede o uso de
índice e fazia esta listagem levar dez segundos num escritório grande.
A máscara é indiferente. 1011214-58.2024 e 1011214582024 acham o
mesmo processo. O número pode estar gravado com ou sem máscara — as duas formas são procuradas.
Hoje procura só no número do processo. O parâmetro é uma barra de pesquisa, não um filtro
por número: conforme a tela evoluir ele passará a procurar também em outros campos (partes, pasta,
número interno). Se você precisa de correspondência exata e estável por um campo específico,
não use q — ele é melhor-esforço por definição.
Autenticação
X-API-Key no cabeçalho. Como autenticar
Parâmetros de consulta6
cpfCnpjClientestringCPF ou CNPJ exato da pessoa vinculada como cliente, com ou sem máscara. Combina com os demais filtros.
encerradobooleanSó encerrados (true) ou só não encerrados (false). Omitir não filtra.
monitoramentoAtivobooleanSó monitorados (true) ou só não monitorados (false). Omitir não filtra. Combina livremente com encerrado.
pageintegerPágina, começando em 1.
perPageintegerItens por página (default 15, máximo 100 — valores acima são reduzidos ao teto, sem erro).
qstringBarra de pesquisa: casa pelo começo do número do processo, com ou sem máscara (não busca trecho do meio). Omitir ou enviar vazio não filtra.
Respostas3
Exemplos ilustrativos · nenhuma requisição é enviada
200 · Sucesso
- Quando acontece
- A operação foi concluída.
- Como tratar
- Leia os dados retornados; em listagens, confira também a paginação.
Exemplo declarado no OpenAPI · application/json
{
"content": [
{
"id": 45210,
"numero": "0001234-96.2026.8.17.0001",
"tribunal": "TJPE",
"grau": "1º Grau",
"partes": "ACME LTDA x João da Silva",
"encerrado": false,
"monitoramentoAtivo": true
}
],
"page": 1,
"perPage": 15,
"total": 1,
"totalPages": 1
}Contrato de respostas
200Página de processos do escritório.
Página de processos do escritório.
application/json
contentProcessoListagemResponse[]Ver propriedades
encerradobooleanProcesso encerrado
graustringGrau / instância; null quando o tribunal não define grau (ex.: administrativo)
idintegerId do processo
monitoramentoAtivobooleanCaptura automática do tribunal ligada para este processo
numerostringNúmero do processo
partesstringPartes da captura mais recente; null se o processo nunca foi capturado
tribunalstringTribunal (descrição). Sempre preenchido: processo sem tribunal vem como "Sem Tribunal", e o administrativo como "Processo Administrativo"
pageintegerperPageintegertotalintegertotalPagesinteger400CPF/CNPJ do cliente inválido.
CPF/CNPJ do cliente inválido.
O contrato não declara um corpo para esta resposta.
401Não autenticado (token ausente/inválido).
Não autenticado (token ausente/inválido).
O contrato não declara um corpo para esta resposta.
