Listar filtros de processos de um cliente

GET

/queries/clients/{clientId}/filters

Lista os filtros disponíveis para a listagem de processos de um cliente, com os valores que existem na consulta de processos mais recente dele. Cada item é um filtro: title é o rótulo para exibição, value é o nome do parâmetro de query em Listar processos de um cliente (pole, status, homonyms, states ou tags) e subMenus traz as opções, cada uma com rótulo (title) e valor a enviar (value). Polo e Homônimos têm opções fixas; Status, Estado e Natureza trazem só os valores encontrados nos processos do cliente, e Estado inclui NI quando há processo sem UF. Quando o cliente ainda não tem consulta de processos, a resposta é uma lista vazia. Só retorna dados de clientes vinculados à empresa do usuário autenticado: cliente inexistente ou sem nome cadastrado devolve 404, e cliente de outra empresa devolve 401. Requer autenticação via Bearer JWT ou header x-api-key.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros Header

Respostas

🟢200

application/json

Filtros disponíveis

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠404Cliente não encontrado

Request Example

Shell

JavaScript

Java

Swift

curl --location '/queries/clients/7c9e6679-7425-40de-944b-e07fc1f90ae7/filters' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

[
    {
        "title": "Polo",
        "value": "pole",
        "subMenus": [
            {
                "title": "ATIVO",
                "value": "ATIVO"
            },
            {
                "title": "PASSIVO",
                "value": "PASSIVO"
            },
            {
                "title": "OUTROS",
                "value": "OUTROS"
            }
        ]
    },
    {
        "title": "Status",
        "value": "status",
        "subMenus": [
            {
                "title": "ARQUIVADO",
                "value": "ARQUIVADO"
            },
            {
                "title": "ATIVO",
                "value": "ATIVO"
            },
            {
                "title": "BAIXADO",
                "value": "BAIXADO"
            },
            {
                "title": "EXTINTO",
                "value": "EXTINTO"
            },
            {
                "title": "INATIVO",
                "value": "INATIVO"
            },
            {
                "title": "OUTROS",
                "value": "OUTROS"
            }
        ]
    },
    {
        "title": "Homonimos",
        "value": "homonyms",
        "subMenus": [
            {
                "title": "SIM",
                "value": "true"
            },
            {
                "title": "NÃO",
                "value": "false"
            }
        ]
    },
    {
        "title": "Estado",
        "value": "states",
        "subMenus": [
            {
                "title": "GO",
                "value": "GO"
            },
            {
                "title": "MT",
                "value": "MT"
            },
            {
                "title": "PA",
                "value": "PA"
            },
            {
                "title": "PR",
                "value": "PR"
            },
            {
                "title": "SP",
                "value": "SP"
            },
            {
                "title": "TO",
                "value": "TO"
            }
        ]
    },
    {
        "title": "Natureza",
        "value": "tags",
        "subMenus": [
            {
                "title": "Cível",
                "value": "CIVIL"
            },
            {
                "title": "Não Identificado",
                "value": "NI"
            },
            {
                "title": "Trabalhista",
                "value": "TRABALHISTA"
            },
            {
                "title": "Tributário",
                "value": "TRIBUTARIO"
            }
        ]
    }
]

Modificado em 2026-10-13 09:47:06

Página anterior

Exportar processos de um cliente (Excel)

Próxima página

Solicitar análise de processo judicial por IA