Lista de leads

Limitaciones
El método está disponible de acuerdo con los permisos del usuario.

Parámetros “with”

Parámetro	Descripción
contacts	Añade información sobre los contactos asociados con el lead a la respuesta.
only_deleted	Si se pasa este parámetro, la solicitud del método retornará solo los leads eliminados que aún podrán ser restaurados en la respuesta. Recibirás modelos de leads con las siguientes propiedades: parámetros “id”, fecha de modificación y “is_deleted” = true.
loss_reason	Añade información detallada sobre el motivo de la pérdida del lead a la respuesta.
is_price_modified_by_robot	Añade una propiedad que representa si el valor de venta del lead fue cambiado por última vez por el Robot a la respuesta.
catalog_elements	Añade los elementos de la lista vinculados al lead a la respuesta.
source_id	Añade el ID de la fuente del lead a la respuesta.

filter[statuses]

❗️
Debido a las limitaciones del servicio, solo puedes filtrar una etapa en un pipeline. Sin embargo, es posible filtrar varias etapas dentro de varios pipelines fuera del servicio.

Encabezado de tipo de datos cuando la solicitud es exitosa
Content-Type: application/hal+json.

Encabezado de tipo de datos en caso de un error
Content-Type: application/problem+json.

Parámetros de respuesta

Parámetro	Tipo de dato	Descripción
id	int	ID del lead.
name	string	Nombre del lead.
price	int	Venta del lead.
responsible_user_id	int	ID del usuario responsable del lead.
group_id	int	Grupo del ID del usuario responsable del lead.
status_id	int	ID de la etapa a la que se añade el lead, la primera etapa del pipeline principal por defecto.
pipeline_id	int	ID del pipeline al que se añade el lead.
loss_reason_id	int	ID del motivo de pérdida del lead.
source_id	int	El parámetro GET “with” es obligatorio. ID de la fuente del lead.
created_by	int	ID del usuario que creó el lead.
updated_by	int	ID del usuario que actualizó el lead.
created_at	int	La hora y fecha en que se creó el lead en formato Unix Timestamp.
updated_at	int	La hora y fecha en que se actualizó el lead en formato Unix Timestamp.
closed_at	int	La hora y fecha en que se cerró el lead en formato Unix Timestamp.
closest_task_at	int	La hora y fecha de la tarea más cercana abierta en formato Unix Timestamp.
custom_fields_values	array\|null	Un array que contiene información sobre los valores de los campos personalizados especificados para este lead.
score	int\|null	Puntuación del lead.
account_id	int	ID de la cuenta en la que se encuentra el lead.
labor_cost	int	Muestra cuánto tiempo se ha invertido en trabajar con la negociación. Tiempo de cálculo en segundos.
is_price_modified_by_robot	bool	El parámetro GET “with” es obligatorio. Define si el valor de venta del lead fue cambiado por el Robot en la última ocasión.
_embedded	object	Datos de entidades asociadas.
_embedded[loss_reason]	object	El parámetro GET “with” es obligatorio. Motivo de pérdida del lead.
_embedded[loss_reason][id]	int	ID del motivo de pérdida.
_embedded[loss_reason][name]	string	Nombre del motivo de pérdida.
_embedded[tags]	array	Arreglo de datos de etiquetas del lead.
_embedded[tags][0]	object	Modelo de etiqueta del lead.
_embedded[tags][0][id]	int	ID de la etiqueta.
_embedded[tags][0][name]	string	Nombre de la etiqueta.
_embedded[tags][0][color]	string/null	Color de la etiqueta.
_embedded[contacts]	array	El parámetro GET “with” es obligatorio. Arreglo de datos de contactos asociados.
_embedded[contacts][0]	object	Datos del contacto vinculado.
_embedded[contacts][0][id]	ints	ID del contacto asociado.
_embedded[contacts][0][is_main]	bool	Define si el contacto es principal para el lead.
_embedded[companies]	array	Arreglo de datos de la compañía asociada. Este arreglo siempre tiene 1 elemento, ya que un lead solo puede estar asociado a 1 compañía.
_embedded[companies][0]	object	Datos de la compañía asociada.
_embedded[companies][0][id]	int	ID de la compañía asociada.
_embedded[catalog_elements]	array	El parámetro GET “with” es obligatorio. Arreglo de datos de los elementos de las listas asociadas.
_embedded[catalog_elements][0]	object	Datos del elemento de la lista asociada.
_embedded[catalog_elements][0][id]	int	ID del elemento asociado.
_embedded[catalog_elements][0][metadata]	object	Metadatos del elemento.
_embedded[catalog_elements][0][quantity]	int	Cantidad de elementos asociados.
_embedded[catalog_elements][0][catalog_id]	int	ID de la lista asociada al elemento.