Saltar al contenido principal

Listar invitados del evento

GET /rest/v1/events/{eventId}/guests

Devuelve los invitados registrados de un evento de la organización de la clave.

Requiere el alcance guests:read. Los encabezados, el límite de peticiones y el formato de error están en Autenticación.

Parámetros de ruta​

ParámetroTipoObligatorioDescripción
eventIdUUID stringSíId del evento cuyos invitados se deben devolver.

La organización se toma de la clave de API. No envíes un parámetro organizationId. El evento debe pertenecer a esa organización.

Parámetros de consulta​

ParámetroTipoObligatorioPredeterminadoDescripción
pageintegerNo1Número de página. Debe ser ≥ 1.
limitintegerNo50Invitados por página. Debe estar entre 1 y 100.
includeAnswersbooleanNofalseSi es true, cada invitado incluye las respuestas de registro.
statusstringNo—registered o waitlist.
searchstringNo—Coincidencia sin distinguir mayúsculas en nombre o correo. Máximo 200 caracteres.
checkedInbooleanNo—true para invitados con hora de check-in; false para quienes no han hecho check-in.
sortstringNoregisteredAtSolo se admite registeredAt.
orderstringNoascasc o desc.

status se calcula a partir del orden de registro y la capacidad del evento:

ValorSignificado
registeredLa posición del invitado (por hora de registro) está dentro de la capacidad, o el evento no tiene límite.
waitlistLa posición del invitado supera la capacidad del evento.

Con includeAnswers=false, cada invitado devuelve answers vacío. Las definiciones de preguntas siguen en questions.

Respuesta 200​

{
"data": [
{
"eventGuestId": "8c7e9f2a-1234-4567-89ab-123456789abc",
"guestId": "4b2c1d3e-5678-90ab-cdef-123456789abc",
"fullName": "John Doe",
"email": "john.doe@example.com",
"phone": "+52 81 1234 5678",
"dateOfBirth": "1995-06-15",
"registeredAt": "2026-09-20T14:30:00.000Z",
"checkedInAt": "2026-09-20T18:05:00.000Z",
"status": "registered",
"answers": [
{
"questionId": 1,
"displayValue": "Yes"
}
]
}
],
"questions": [],
"pagination": {
"totalCount": 1,
"page": 1,
"pageSize": 50,
"totalPages": 1
}
}
CampoTipoNuloDescripción
eventGuestIdstringNoId de la fila de registro evento–invitado.
guestIdstringNoId del perfil del invitado.
fullNamestringNoNombre completo.
emailstringNoCorreo electrónico.
phonestringSíTeléfono.
dateOfBirthstringSíFecha de nacimiento como YYYY-MM-DD.
registeredAtstringNoHora de registro en ISO 8601.
checkedInAtstringSíHora de check-in en ISO 8601, o null si no ha hecho check-in.
statusstringNoregistered o waitlist.
answersarrayNoRespuestas cuando includeAnswers=true; si no, [].

Cada respuesta es { questionId: number, displayValue: string }. En preguntas de opción, displayValue es la etiqueta de la opción. En preguntas de texto, es el valor guardado.

questions usa la misma estructura que las preguntas de registro de la aplicación.

pagination.totalCount es el número de invitados que coinciden con los filtros, no solo la página actual.

Errores​

Los códigos compartidos están en Autenticación. Estos son específicos de esta ruta:

400 consulta inválida​

{
"error": {
"code": "INVALID_REQUEST",
"message": "One or more query parameters are invalid.",
"details": {
"page": "Must be greater than or equal to 1.",
"limit": "Must be between 1 and 100."
}
}
}

403 sin alcance​

{
"error": {
"code": "FORBIDDEN",
"message": "The API key does not have permission to access guests."
}
}

404 evento desconocido​

GET /rest/v1/events/7f4c1b2e-8e9b-4e31-9c1d-123456789abc/guests
{
"error": {
"code": "NOT_FOUND",
"message": "The requested event was not found."
}
}

Un evento de otra organización tampoco se encuentra.

405 otros métodos​

POST /rest/v1/events/{eventId}/guests
{
"error": {
"code": "METHOD_NOT_ALLOWED",
"message": "Only GET requests are allowed for this resource."
}
}

La respuesta incluye Allow: GET.

Para enviar un recordatorio a un invitado con enlace de cancelación, consulta Enviar recordatorio a un invitado.