v1

latestOpenAPI 3.1.02026-07-261630686.8 KB

Lista de leads

Este método permite obtener una lista de leads en la cuenta.

get/api/v4/leads

Query parameters

withstring

Este parámetro acepta una cadena que puede contener varios valores (consulta la tabla de arriba) separados por comas

pageinteger

Página de lista de leads

limitinteger

La cantidad de entidades retornadas por solicitud (límite – 250)

querystring

Consulta de búsqueda (Búsquedas a través de los campos completados de la entidad)

order[created_at]'asc' | 'desc'

Ordena los resultados

order[updated_at]'asc' | 'desc'

Ordena los resultados

order[id]'asc' | 'desc'

Ordena los resultados

filter[id][]integer[]

Filtrar por ID de lead

filter[name][]string[]

Filtrar por nombre del lead

filter[price]integer

Filtrar por precio del lead

filter[created_by][]integer[]

Filtrar por ID del usuario que creó la entidad

filter[updated_by][]integer[]

Filtrar por ID del usuario que modificó la entidad por última vez

filter[responsible_user_id][]integer[]

Filtrar por ID del usuario responsable de la entidad

filter[created_at][from]integer

Filtrar por la fecha de creación del lead. Fecha en formato Unix Timestamp

filter[created_at][to]integer

Filtrar por la fecha de creación del lead. Fecha en formato Unix Timestamp

filter[updated_at][from]integer

Filtrar por la última fecha de actualización del lead. Fecha en formato Unix Timestamp

filter[updated_at][to]integer

Filtrar por la última fecha de actualización del lead. Fecha en formato Unix Timestamp

filter[closed_at][from]integer

Filtrar por la fecha de cierre del lead. Fecha en formato Unix Timestamp

filter[closed_at][to]integer

Filtrar por la fecha de cierre del lead. Fecha en formato Unix Timestamp

filter[closest_task_at][from]integer

Filtrar leads por la fecha de la tarea más próxima a completarse. Fecha en formato Unix Timestamp

filter[closest_task_at][to]integer

Fecha en formato Unix Timestamp

filter[pipeline_id][]integer[]

Filtrar por ID de pipeline

filter[statuses][0][pipeline_id]integer

Debe utilizarse con filter[statuses][0][status_id]. Este filtro permite filtrar leads según sus etapas específicas

filter[statuses][0][status_id]integer

Debe utilizarse con filter[statuses][0][pipeline_id]. Este filtro permite filtrar leads según sus etapas específicas

Response

200

_pageinteger

Example response

{
  "_page": 1,
  "_links": {
    "self": {
      "href": "ENLACE"
    }
  },
  "_embedded": {
    "leads": [
      {
        "id": 152462,
        "name": "Ejemplo Lead 1",
        "price": 15000,
        "responsible_user_id": 8375357,
        "status_id": 58141807,
        "pipeline_id": 6950551,
        "created_by": 8375357,
        "created_at": 1686673336,
        "updated_at": 1686747000,
        "closest_task_at": 1686850200,
        "custom_fields_values": [
          {
            "field_id": 184994,
            "field_name": "Venta",
            "field_type": "checkbox",
            "values": [
              {
                "value": true
              }
            ]
          }
        ],
        "account_id": 31361463,
        "source_id": 20692839,
        "is_price_modified_by_robot": true,
        "_links": {
          "self": {
            "href": "ENLACE"
          }
        }
      }
    ]
  }
}