API de Leads
Endpoints para crear, consultar, actualizar y eliminar leads en SalesOS.
Endpoints
Listar leads
Parámetros de consulta:
| Parámetro | Tipo | Descripción |
|---|
page | number | Número de página (default: 1) |
per_page | number | Registros por página (default: 20, max: 100) |
search | string | Búsqueda por nombre, email o teléfono |
stage | string | Filtrar por etapa del pipeline |
assigned_to | string | Filtrar por vendedor asignado |
created_after | string | Filtrar leads creados después de esta fecha (ISO 8601) |
created_before | string | Filtrar leads creados antes de esta fecha (ISO 8601) |
curl -H "Authorization: Bearer TU_TOKEN" \
"https://api.play2sell.com/v1/leads?page=1&per_page=20&stage=prospecting"
{
"data": [
{
"id": "lead_abc123",
"name": "Juan Pérez",
"email": "juan@empresa.com",
"phone": "+52 55 1234 5678",
"company": "Empresa SA",
"stage": "prospecting",
"assigned_to": "user_xyz789",
"score": 75,
"created_at": "2026-03-01T10:00:00Z",
"updated_at": "2026-03-10T15:30:00Z"
}
],
"pagination": {
"total": 150,
"page": 1,
"per_page": 20,
"total_pages": 8
}
}
Obtener un lead
Crear un lead
Cuerpo de la solicitud:
{
"name": "María García",
"email": "maria@empresa.com",
"phone": "+52 55 9876 5432",
"company": "Tech Corp",
"stage": "prospecting",
"source": "website",
"custom_fields": {
"sector": "tecnología",
"employees": 50
}
}
name, email
Actualizar un lead
Envía solo los campos que deseas actualizar:
{
"stage": "proposal",
"score": 85
}
Eliminar un lead
La eliminación de un lead es permanente y no se puede deshacer. Todos los datos asociados (notas, actividades, historial) también serán eliminados.
Webhooks relacionados
Para recibir notificaciones cuando ocurren cambios en los leads, configura webhooks para los siguientes eventos:
lead.created — Nuevo lead creadolead.updated — Lead actualizadolead.deleted — Lead eliminadolead.stage_changed — Lead cambió de etapa
Todos los endpoints requieren autenticación. Consulta la guía de autenticación para obtener tu token de acceso. Próximos pasos
