Listar consultas de um cliente por serviço

GET

/queries/clients/{clientId}

Lista as consultas já solicitadas para o cliente informado em clientId, agrupadas por serviço. A resposta é um objeto cujas chaves são os códigos dos serviços (por exemplo bvs-juridica, protestos e cerc-publicidade) e cujos valores são listas de consultas daquele serviço, da mais recente para a mais antiga. Cada item traz queryId (o identificador da consulta, que as rotas de resultado recebem no caminho), status (a situação do serviço na consulta, como FILA, EM_PROGRESSO, FINALIZADO ou FALHOU), createdAt (quando a consulta foi solicitada), completedAt (quando o serviço terminou; pode estar ausente enquanto não terminou), requestedBy (id e nome de quem solicitou) e taxId (o CPF ou CNPJ consultado). Para alguns serviços a lista traz todas as consultas já feitas; para os demais, só as da consulta mais recente que incluiu o serviço. Cliente sem consultas devolve um objeto vazio. Para ver os dados de um serviço, use a rota de resultado correspondente com o queryId. Requer autenticação via Bearer JWT ou header x-api-key. O cliente precisa pertencer à empresa do usuário: cliente inexistente devolve 404 (Cliente não encontrado), cliente de outra empresa devolve 401 (Acesso negado) e usuário inativo devolve 404 (Usuário não encontrado).

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

Consultas do cliente agrupadas por serviço

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Sucesso

{
    "bvs-juridica": [
        {
            "queryId": "3f6b1d2e-8c4a-4b7e-9d1a-5e2c7a9b0f13",
            "status": "FINALIZADO",
            "createdAt": "2026-09-18T14:02:11.402Z",
            "completedAt": "2026-09-18T14:02:40.118Z",
            "requestedBy": {
                "id": "e21c4d5a-9b8f-4c70-a3d2-6f1e0b9c8a47",
                "name": "Usuária Exemplo"
            },
            "taxId": "11222333000181"
        }
    ],
    "protestos": [
        {
            "queryId": "3f6b1d2e-8c4a-4b7e-9d1a-5e2c7a9b0f13",
            "status": "FINALIZADO",
            "createdAt": "2026-09-18T14:02:11.402Z",
            "completedAt": "2026-09-18T14:03:02.771Z",
            "requestedBy": {
                "id": "e21c4d5a-9b8f-4c70-a3d2-6f1e0b9c8a47",
                "name": "Usuária Exemplo"
            },
            "taxId": "11222333000181"
        },
        {
            "queryId": "9a1e7c3d-4b2f-4d58-b6a0-3c5e8f1d2b74",
            "status": "FINALIZADO",
            "createdAt": "2026-08-02T10:15:44.019Z",
            "completedAt": "2026-08-02T10:16:31.560Z",
            "requestedBy": {
                "id": "e21c4d5a-9b8f-4c70-a3d2-6f1e0b9c8a47",
                "name": "Usuária Exemplo"
            },
            "taxId": "11222333000181"
        }
    ],
    "cerc-publicidade": [
        {
            "queryId": "3f6b1d2e-8c4a-4b7e-9d1a-5e2c7a9b0f13",
            "status": "EM_PROGRESSO",
            "createdAt": "2026-09-18T14:02:11.402Z",
            "requestedBy": {
                "id": "e21c4d5a-9b8f-4c70-a3d2-6f1e0b9c8a47",
                "name": "Usuária Exemplo"
            },
            "taxId": "11222333000181"
        }
    ]
}

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

Página anterior

Listar consultas de um cliente

Próxima página

Consultar status geral de uma consulta