Skip to main content

​
API de Leads

Endpoints para crear, consultar, actualizar y eliminar leads en SalesOS.

​
Endpoints

​
Listar leads

GET /v1/leads
Parámetros de consulta:
ParámetroTipoDescripción
pagenumberNúmero de página (default: 1)
per_pagenumberRegistros por página (default: 20, max: 100)
searchstringBúsqueda por nombre, email o teléfono
stagestringFiltrar por etapa del pipeline
assigned_tostringFiltrar por vendedor asignado
created_afterstringFiltrar leads creados después de esta fecha (ISO 8601)
created_beforestringFiltrar leads creados antes de esta fecha (ISO 8601)
Ejemplo de solicitud: 
curl -H "Authorization: Bearer TU_TOKEN" \
  "https://api.play2sell.com/v1/leads?page=1&per_page=20&stage=prospecting"
Ejemplo de respuesta: 
{
  "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

GET /v1/leads/:id

​
Crear un lead

POST /v1/leads
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
  }
}
Campos requeridos: name, email

​
Actualizar un lead

PATCH /v1/leads/:id
Envía solo los campos que deseas actualizar: 
{
  "stage": "proposal",
  "score": 85
}

​
Eliminar un lead

DELETE /v1/leads/:id
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 creado
  • lead.updated — Lead actualizado
  • lead.deleted — Lead eliminado
  • lead.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

API de Ventas

Gestiona oportunidades vía API.

Webhooks

Recibe eventos en tiempo real.