Pesquisar clientes para monitoramento

Lista os clientes da empresa do usuário que podem entrar em um monitoramento: pessoas físicas e jurídicas, sem os excluídos da base de clientes, ordenadas pelo nome, com os sem nome no fim.

search busca parte do nome, sem diferenciar maiúsculas nem acentos, ou parte do CPF/CNPJ. Com monitoringId, os clientes que já estão nesse monitoramento ficam fora da lista, para incluir clientes novos nele. alreadyMonitoredElsewhere indica se o cliente já está em outro monitoramento da empresa, de qualquer usuário e em qualquer status. offset e limit inválidos não geram erro: valem os padrões (0 e 20), e limit fica entre 1 e 100.

Um monitoringId que não existe na empresa devolve 404 (Monitoria não encontrada.). Requer autenticação via Bearer JWT ou header x-api-key e as permissões de ver monitoramentos e de ver clientes. Usuário sem perfil de permissão recebe 403 (Acesso negado); perfil inexistente, 401 (Permissão inválida!); perfil sem alguma das permissões, 400 (Permissão não encontrada); usuário inativo, 404 (Usuário não encontrado).

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

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

Respostas

🟢200Sucesso

application/json

Clientes que podem ser monitorados

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

🟠400Sem permissão para ver monitoramentos ou clientes

🟠403Acesso negado

🟠404Monitoramento não encontrado

curl --location '/v2/monitoring/clients?monitoringId=9c1e4b7a-0000-4000-8000-000000000d01&search=Exemplo&offset=0&limit=20' \ --header 'x-api-key: SUA_CHAVE_DE_API' \ --header 'Authorization: Bearer <token>'

{ "items": [ { "_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7", "name": "Empresa Exemplo Ltda", "taxId": "11222333000181", "kind": "legal", "alreadyMonitoredElsewhere": true }, { "_id": "0e7a3c58-91d4-4b6f-8c2a-5d3b9f1e6a22", "name": "Maria Exemplo da Silva", "taxId": "11144477735", "kind": "natural", "alreadyMonitoredElsewhere": true } ], "total": 2, "offset": 0, "limit": 20 }

Pesquisar clientes para monitoramento

Requisição

Respostas