Buscar leads por id, e-mail ou telefone

🔒

Autenticação necessária

Esta API utiliza Bearer Token no header Authorization.

Autocomplete de lead para os modais da Agenda V2. O critério segue o comportamento
histórico: um termo com formato de e-mail é procurado em email; qualquer outro é
procurado em telefone e no início do idlead. Não busca por nome.

Leads que possuem associado ativo ficam fora do resultado.

O resultado respeita o escopo de visualização do painel: corretor, usuário de
imobiliária e PDV só alcançam os próprios leads; o gestor é limitado pelo perfil de
visualização e pela gestão de times. Sem termo, devolve listagem vazia sem
consultar a base.

O campo label já vem montado (Lead #123 - Nome (contato)) para o consumidor não
precisar refazer a formatação.

Cada item já vem com o contexto que os modais de tarefa e visita da Agenda V2
precisam — PDV, empreendimentos e permissões de workflow do painel logado —,
resolvido em lote para não gerar N+1 quando a busca devolve vários leads. As
permissões vêm das visualizações do workflow da situação de cada lead; o workflow
não define visualizações para o tipo PDV, então nesse painel as ações chegam
liberadas, pois não existe intenção configurada de bloqueio.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Id, e-mail ou telefone. Vazio devolve listagem vazia.

integer
integer

Padrão 20, máximo 50.

Response

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json