R2 Connect API

Clientes

Directorio de clientes y huéspedes del negocio con su historial de visitas y consumo.

GET/guestsrequiere read:guests

Ordenados por visita más reciente. Incluye tanto clientes con consumo como prospectos que aún no compran.

Parámetros#

Parámetro	Tipo	Descripción
limit	integer	Resultados por página. Entre 1 y 50. Predeterminado: 25.
cursor	string	Cursor de la página siguiente.

Campos#

Campo	Tipo	Descripción
name	string	Nombre del cliente.
email · phone	string	Contacto. Pueden ser `null` si el negocio no los capturó.
country	string	País, cuando se conoce.
status	string	`customer` si ya compró, `prospect` si aún no.
visit_count	integer	Estancias o visitas efectivas.
total_spent	number	Consumo acumulado en el negocio.
segment	string	Segmento de valor calculado por R2.
no_show_count	integer	Veces que no se presentó a una reserva.
first_visit_at · last_visit_at	datetime	Primera y última visita.

Son datos personales

Este recurso entrega información personal de personas reales. Trátala conforme a la ley de protección de datos que aplique al negocio y a tu empresa: guárdala cifrada, limita quién puede verla, y bórrala cuando termine la relación comercial o cuando el titular lo solicite.

Ejemplo#

json

{
  "data": [
    {
      "id": "u82jd7fk2msq04nb",
      "name": "Gabriela Ortiz",
      "email": "[email protected]",
      "phone": "+525551234567",
      "country": "MX",
      "status": "customer",
      "visit_count": 4,
      "total_spent": 18400,
      "segment": "loyal",
      "no_show_count": 0,
      "first_visit_at": "2025-11-02T18:30:00.000Z",
      "last_visit_at": "2026-07-16T10:15:00.038Z"
    }
  ],
  "pagination": { "cursor": "g3QAAAACZAAE…", "has_more": true }
}

AnteriorPagos SiguienteCatálogo