Skip to main content

Listar leads

Devuelve todos los leads capturados por los agentes de la organización, ordenados por fecha de creación descendente. Se puede filtrar por agente.
GET https://app.chatnorris.ai/api/v2/leads
Authorization: Bearer <tu_api_key>
Scope requerido: leads:read

Query parameters

ParámetroTipoDescripción
chatbot_idstringFiltrar leads de un agente específico
pageintegerNúmero de página. Default: 1
per_pageintegerResultados por página. Default: 25, máximo 100

Respuesta

{
  "status": "success",
  "data": {
    "leads": [
      {
        "id": "lead_abc123",
        "chatbot_id": "bot_xyz789",
        "conversation_id": "conv_def456",
        "name": "María García",
        "email": "maria@empresa.com",
        "phone": "+5491112345678",
        "extra_data": {
          "company": "Empresa SA"
        },
        "created_at": "2026-06-25T11:30:00.000Z"
      }
    ]
  },
  "pages": {
    "current_page": 1,
    "last_page": 5,
    "per_page": 25,
    "total": 112
  }
}

Campos de respuesta

CampoTipoDescripción
idstringID único del lead
chatbot_idstringID del agente que capturó el lead
conversation_idstringID de la conversación asociada
namestring | nullNombre del lead
emailstring | nullEmail del lead
phonestring | nullTeléfono del lead
extra_dataobject | nullDatos adicionales capturados
created_atstringFecha de captura (ISO 8601)