Consultar Lead por número de celular #

Este método permite encontrar un Lead en la base de datos de LeanCore a través de su número de celular.

URL del endpoint #

GET /lead

Parámetros de entrada #

Parámetro	Tipo	Descripción
phone	string	Número de celular del lead

Encabezados #

Encabezado	Valor
Authorization	Bearer {token}
Content-Type	application/json

Respuesta esperada #

El método devuelve una respuesta en formato JSON con los siguientes campos:

• En caso de éxito, la respuesta tendrá el código de estado 200 y contendrá los siguientes datos:

{
  "id": "string",
  "image": "string",
  "name": "string",
  "lastname": "string",
  "business_name": "string",
  "quota": 0,
  "status": "string",
  "phone": "string",
  "email": "string",
  "nit": "string",
  "address": "string",
  "history": [],
  "score": 0.0,
  "payment_data": {},
  "apn_token": "string",
  "ecosystem": "string",
  "business_entity": "string",
  "additional_data": {}
}

Donde:

• id: ID del lead.
• image (opcional): URL de la imagen asociada al lead.
• name: Nombre del lead.
• lastname: Apellido del lead.
• business_name: Nombre de la empresa del lead.
• quota: Cuota del lead.
• status: Estado del lead.
• phone: Número de teléfono del lead.
• email: Dirección de correo electrónico del lead.
• nit: NIT del lead.
• address: Dirección del lead.
• history (opcional): Historial del lead.
• score (opcional): Puntaje del lead.
• payment_data (opcional): Datos de pago del lead.
• apn_token (opcional): Token de APN (Apple Push Notification) asociado al lead.
• ecosystem: Ecosistema del lead.
• business_entity: Entidad empresarial del lead.
• additional_data (opcional): Datos adicionales del lead.

Ejemplos de uso #

Python #

import requests

url = "https://api.leancore.co/lead"
headers = {
    "Authorization": "Bearer <token>"
}
params = {
    "phone": "573136434030"
}

response = requests.get(url, headers=headers, params=params)

if response.status_code == 200:
    lead = response.json()
    print("Lead encontrado:")
    print(lead)
else:
    print("Error al consultar el lead. Código de respuesta:", response.status_code)
    print("Mensaje de error:", response.text)