Classes - Escavador Business API - Documentação

Grupo

Classes

Listar Classes

GET /api/v2/classes
Requer autenticaçãoGrátis

Retorna uma lista paginada de classes processuais disponíveis.

Visão geral

  • Este endpoint exige autenticação.
  • Método HTTP: GET.

Query Parameters

?
nome não informado Opcional

Nome da classe para busca (match parcial).

path não informado Opcional

Hierarquia/caminho da classe (match parcial).

raiz boolean Opcional

Filtra classes processuais raiz quando 1 e as demais classes quando 0. Uma classe raiz é o nível mais amplo da hierarquia, sem classe pai, como "PROCESSO CÍVEL E DO TRABALHO". Quando omitido, retorna ambos os tipos. Veja o campo classe_raiz na estrutura ClasseProcessual.

limit integer Opcional

Quantidade de classes por página. Default: 20. Valores permitidos: 20, 50 ou 100 (máximo: 100).

Exemplos de respostas válidas

Esse é um exemplo de resposta bem-sucedida.

HTTP 200 ? 
{
    "items": [
        {
            "codigo_cnj": "2",
            "classe_raiz": true,
            "nome": "PROCESSO CÍVEL E DO TRABALHO",
            "path_completo": "PROCESSO CÍVEL E DO TRABALHO"
        },
        {
            "codigo_cnj": "7",
            "classe_raiz": false,
            "nome": "Procedimento Comum Cível",
            "path_completo": "PROCESSO CÍVEL E DO TRABALHO > Processo de Conhecimento > Procedimento de Conhecimento > Procedimento Comum Cível"
        }
    ],
    "links": {
        "next": "https://api.escavador.com/api/v2/classes?cursor=eyJpZCI6MTgyMSwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ"
    },
    "paginator": {
        "per_page": 20
    }
}
HTTP 401 ? 
{
    "error": "Unauthenticated"
}
HTTP 404 ? 
{
    "error": "NotFound"
}