Leads

Pesquisar

<aside>🔒 Para acessar essa rota é necessária pelo menos uma permissão de Lead</aside>
get/persons/leads

Request

  • Base URL: https://api.apresenta.me
  • URL: https://api.apresenta.me/persons/leads
  • Auth: HTTP bearer

Query parameters

sortstring

Campo para ordenar os registros

Example:id
fieldsstring

Lista de campos separados por vírgula sem espaço para incluir na resposta

Example:id,name,phone,email
filter[id]integer

Filtra por código

Example:2
filter[name]string

Filtra por nome

Example:%exemplo%
filter[date]string

Filtra por data do contato

Example:2024-01-01
filter[email]string

Filtra por e-mail

Example:example@mail.com
filter[status]string

Filtra por status, permitindo: read, 'not-read', 'filed' e 'distribuition'

Example:read
filter[phone]string

Filtra por telefone

Example:999999999
filter[purpose]string

Filtra por Finalidade, podendo ser: change, rent, sale, season

Example:rent
filter[building_id]integer

Filtra por ID do Imóvel

Example:123456
filter[origin_id]integer

Filtra por ID de origem

Example:1
filter[origin_details]string

Filtra por detalhe de origem

Example:%Site%
filter[message]string

Filtra por mensagem

Example:Tenho interesse%
filter[notes]string

Filtra por observações

Example:Deseja casa no bairro%
filter[ads_campaign]string

Filtra por ID de campanha ADS

Example:Cj0KCQiA4L2FFhCvARIsAO0SBdZrTYfubPvY61Sggf1yElI7IXn6YgdOcJqXm0kHXdhLMR0nTlJzyWAaAg5ZEALw_wcB
filter[deal_id]integer

Filtra por código do negócio vinculado ao lead.

Example:123
filter[ad_name]string

Filtra por Nome do anúncio.

Example:Nome Teste
filter[adset_name]string

Filtra por Nome do conjunto de anúncio.

Example:Conjunto Teste
include[origin]string

Incluir dados da Origem do Lead

Example:id
include[building]string

Incluir dados do Imóvel vinculado

Example:reference,title
include[deal]string

Incluir dados da Origem do Lead

Example:id,title
include[formBuilder]string

Retorna os dados do formulário dinâmico, caso o lead tenha entrado via formulário dinâmico.

Example:id,name

Changes

No recorded changes to this operation across all 1 revision of this API.