Buscar processos para seleção
GET · API de Integração v2
/v2/processos/opcoesBuscar processos para seleção
Devolve uma página de processos do seu escritório num formato enxuto, pensado para preencher um campo de seleção — não é a listagem completa nem a ficha do processo.
Para que serve: descobrir o id a informar em outras rotas que se referem a um processo (por exemplo, ao criar um compromisso em POST /v2/agenda).
Busca: q casa pelo número do processo. Omitir q devolve a primeira página sem filtrar.
Cliente: cpfCnpjCliente filtra pelo CPF/CNPJ exato da pessoa vinculada
como cliente, aceitando o valor com ou sem máscara. Pode ser combinado com q.
Paginação: page começa em 1; perPage vale 15 por padrão e é limitado a 100 (valores maiores são reduzidos ao teto, sem erro). A resposta ecoa page/perPage aplicados e o total de registros.
Escopo: só processos do escritório do token. Não há parâmetro para consultar outro escritório.
Autenticação
X-API-Key no cabeçalho. Como autenticar
Parâmetros de consulta4
cpfCnpjClientestringCPF ou CNPJ exato da pessoa vinculada como cliente, com ou sem máscara. Combina com q quando os dois forem informados.
pageintegerPágina, começando em 1.
perPageintegerItens por página (default 15, máximo 100 — valores acima são reduzidos ao teto, sem erro).
qstringTexto de busca (número do processo). Ausente/vazio devolve a primeira página sem filtrar.
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"
}
],
"page": 1,
"perPage": 15,
"total": 1
}Contrato de respostas
200Página de processos (vazia se nada casar com a busca).
Página de processos (vazia se nada casar com a busca).
application/json
contentProcessoResponse[]Ver propriedades
graustringGrau / instância
idintegerId do processo (passar em processoId)
numerostringNúmero do processo
partesstringPartes do processo
tribunalstringTribunal (descrição amigável)
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.
