Lista de Leads

Este método permite obter uma lista de leads na conta

Limitações
O método está disponível de acordo com os direitos do usuário.

Parâmetros“with”

ParâmetroDescrição
contactsAdiciona informações sobre os contatos associados ao lead à resposta
only_deletedSe este parâmetro for passado, a solicitação do método retornará apenas os leads deletados que ainda são restauráveis na resposta. Você receberá modelos de lead com as seguintes propriedades: “id”, data de modificação e parâmetro “is_deleted” = true
loss_reasonAdiciona informações detalhadas sobre o motivo da perda do lead à resposta
is_price_modified_by_robotAdiciona uma propriedade que representa se o valor da venda do lead foi alterado pela última vez por um Robô à resposta
catalog_elementsAdiciona itens de listas vinculados ao lead à resposta
source_idAdiciona o ID da fonte do lead à resposta
sourceAñade en la respuesta información sobre la fuente, su ID y nombre

filter[statuses]

❗️

Devido às limitações do serviço, você pode filtrar apenas um estágio em um pipeline. Porém, é possível filtrar vários estágios dentro de vários pipelines fora do serviço.

Cabeçalho de tipo de dado quando a solicitação é bem-sucedida
Content-Type: application/hal+json

Cabeçalho de tipo de dado em caso de erro
Content-Type: application/problem+json

Parâmetros de resposta

Parâmetro

Tipo de dado

Descrição

id

int

ID do Lead

name

string

Nome do Lead

price

int

Venda do Lead

responsible_user_id

int

ID do usuário responsável pelo Lead

group_id

int

ID do Grupo do usuário responsável pelo Lead

status_id

int

ID da Etapa à qual o Lead foi adicionado, sendo a primeira etapa do pipeline principal a padrão

pipeline_id

int

ID do Pipeline ao qual o Lead foi adicionado

loss_reason_id

int

ID do motivo da perda do Lead

source_id

int

O parâmetro GET “with” é obrigatório. ID da Fonte do Lead

created_by

int

ID do Usuário que criou o Lead

updated_by

int

ID do Usuário que atualizou o Lead

created_at

int

A data e hora em que o lead foi criado no formato de Unix Timestamp

updated_at

int

A data e hora em que o lead foi atualizado no formato de Unix Timestamp

closed_at

int

A data e hora em que o lead foi fechado no formato de Unix Timestamp

closest_task_at

int

A data e hora da tarefa aberta mais próxima no formato de Unix Timestamp

custom_fields_values

array|null

Um array contendo informações sobre os valores dos campos personalizados especificados para este Lead

score

int|null

Pontuação do Lead

account_id

int

ID da Conta onde o Lead está localizado

labor_cost

int

Mostra quanto tempo foi gasto trabalhando com o negócio. O tempo é calculado em segundos.

is_price_modified_by_robot

bool

O parâmetro GET “with” é obrigatório. Defines whether the lead sale value was changed by the Robot last time

  • embedded

object

Dados de entidades incorporadas

  • embedded[loss_reason][loss_reason]

object

O parâmetro GET “with” é obrigatório.
Razão da perda do Lead

  • embedded[loss_reason][id]

int

ID da razão da perda

  • embedded[loss_reason][name]

string

Nome da razão da perda

  • embedded[tags]

array

Array de dados das tags do Lead

  • embedded[tags][0]

object

Modelo de tag do Lead

  • embedded[tags][0][id]

int

ID da tag

  • embedded[tags][0][name]

string

Nome da tag

  • embedded[tags][0][color]

string/null

Cor da tag

  • embedded[contacts]

array

O parâmetro GET “with” é obrigatório.
Array de dados dos contatos vinculados

  • embedded[contacts][0]

object

Dados do contato vinculado

  • embedded[contacts][0][id]

ints

ID do contato vinculado

  • embedded[contacts][0][is_main][is_main]

bool

Define se o contato é principal para o lead

  • embedded[companies]

array

Array de dados das empresas vinculadas. Este array sempre consiste em 1 elemento, pois o lead pode ter apenas 1 empresa vinculada

  • embedded[companies][0]

object

Dados da empresa vinculada

  • embedded[companies][0][id]

int

ID da empresa vinculada

  • embedded[catalog_elements][catalog_elements]

array

O parâmetro GET “with” é obrigatório.
Array de dados dos elementos das listas vinculadas

  • embedded[catalog_elements][0]

object

Dados do elemento da lista vinculada

  • embedded[catalog_elements][0][id]

int

ID do elemento vinculado

  • embedded[catalog_elements][0][metadata]

object

Meta-dados do elemento

  • embedded[catalog_elements][0][quantity]

int

Quantidade do elemento vinculado

  • embedded[catalog_elements][0][catalog_id][catalog_id]

int

ID da lista do elemento vinculado

  • embedded[source]

object

O parâmetro GET "with" é obrigatório. Fonte do lead

  • embedded[source][id]

int

ID da fonte do lead

  • embedded[source][name]

string

Nome da fonte do lead

Query Params
string

Este parâmetro aceita uma string que pode consistir em vários valores (veja a tabela acima) separados por vírgulas.

int32

Página da lista de leads

int32

O número de entidades retornadas por solicitação (limite – 250)

string

Consulta de pesquisa (pesquisa nos campos preenchidos da entidade)

string

Ordenação dos resultados

string

Ordenação dos resultados

string

Ordenação dos resultados

filter[id][]
array of int32s

Filtrar por ID do lead

filter[id][]
filter[name][]
array of strings

Filtrar por nome do lead

filter[name][]
int32

Filtrar por preço do lead

filter[created_by][]
array of int32s

Filtrar por ID do usuário que criou a entidade

filter[created_by][]
filter[updated_by][]
array of int32s

Filtrar por ID do usuário que alterou a entidade por último

filter[updated_by][]
filter[responsible_user_id][]
array of int32s

Filtrar por ID do usuário responsável pela entidade

filter[responsible_user_id][]
int32

Filtrar pela data de criação do lead. Data no formato Unix Timestamp

int32

Filtrar pela data de criação do lead. Data no formato Unix Timestamp

int32

Filtrar pela data da última atualização do lead. Data no formato Unix Timestamp

int32

Filtrar pela data da última atualização do lead. Data no formato Unix Timestamp

int32

Filtrar pela data de fechamento do lead. Data no formato Unix Timestamp

int32

Filtrar pela data de fechamento do lead. Data no formato Unix Timestamp

int32

Filtrar leads pela data da tarefa mais próxima da conclusão. Data no formato Unix Timestamp

int32

Filtrar leads pela data da tarefa mais próxima da conclusão. Data no formato Unix Timestamp

filter[pipeline_id][]
array of int32s

Filtrar por ID do pipeline

filter[pipeline_id][]
int32

Deve ser usado com filter[statuses][0][status_id]. O filtro permite filtrar leads com base em seus estágios específicos.

int32

Deve ser usado com filter[statuses][0][pipeline_id]. O filtro permite filtrar leads com base em seus estágios específicos.

Responses

Language
Credentials
OAuth2
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain