`with` parâmetro	Descrição
catalog_elements	Adiciona itens de listas vinculados ao lead à resposta
is_price_modified_by_robot	Adiciona uma propriedade que representa se o valor de venda do lead foi alterado pela última vez pelo Robô à resposta
loss_reason	Adiciona informações detalhadas sobre o motivo da perda do lead à resposta
contacts	Adiciona informações sobre os contatos associados ao lead à resposta
only_deleted	Se este parâmetro for passado, a solicitação do método retornará apenas os leads deletados que ainda podem ser restaurados na resposta. Você receberá modelos de leads com as seguintes propriedades: “id”, data de modificação e parâmetro “is_deleted” = true.
source_id	Adiciona na reposta o ID a fonte
source	Adiciona na resposta informações sobre a fonte, o ID e nome

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

Tipo de autorização
OAuth 2.0 com Token de Acesso / Token de Longa Duraçã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

200200

204204

400400

401401

429429

500500