v1

latestOpenAPI 3.1.02026-07-261630686.8 KB

Obtener un lead por su ID

Este método permite obtener los datos específicos de un lead mediante su ID.

get/api/v4/leads/{id}

Path parameters

idinteger required

ID del lead

Query parameters

withstring

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

Response

200

idinteger

namestring

priceinteger

responsible_user_idinteger

group_idinteger

status_idinteger

pipeline_idinteger

{"stackTrail":"paths:/api/v4/leads/{id}:get:responses:200:content:application/json:schema:properties:loss_reason_id","oasType":"schema","type":"unknown"}

created_byinteger

updated_byinteger

created_atinteger

updated_atinteger

{"stackTrail":"paths:/api/v4/leads/{id}:get:responses:200:content:application/json:schema:properties:closed_at","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/api/v4/leads/{id}:get:responses:200:content:application/json:schema:properties:closest_task_at","oasType":"schema","type":"unknown"}

is_deletedboolean

{"stackTrail":"paths:/api/v4/leads/{id}:get:responses:200:content:application/json:schema:properties:score","oasType":"schema","type":"unknown"}

account_idinteger

{"stackTrail":"paths:/api/v4/leads/{id}:get:responses:200:content:application/json:schema:properties:labor_cost","oasType":"schema","type":"unknown"}

is_price_computedboolean

Example response

{
  "id": 152464,
  "name": "Ejemplo lead 2",
  "price": 20000,
  "responsible_user_id": 8375357,
  "status_id": 58141807,
  "pipeline_id": 6950551,
  "updated_by": 8375357,
  "created_at": 1686673337,
  "updated_at": 1686748504,
  "custom_fields_values": [
    {
      "field_id": 184994,
      "field_name": "Venta",
      "field_type": "checkbox",
      "values": [
        {
          "value": true
        }
      ]
    }
  ],
  "account_id": 31361463,
  "_links": {
    "self": {
      "href": "https://devteam.kommo.com/api/v4/leads/152464?page=1&limit=50"
    }
  },
  "_embedded": {
    "tags": [
      {
        "id": 2164,
        "name": "Ex"
      }
    ]
  }
}