Listar eventos

GET /rest/v1/events

Devuelve los eventos de la organización de la clave, incluidos borradores, eventos privados y eventos solo por invitación.

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

Parámetros

Parámetro	Tipo	Obligatorio	Predeterminado	Descripción
page	entero	No	1	Número de página. Debe ser ≥ 1.
limit	entero	No	50	Eventos por página. De 1 a 100.
status	string	No	—	draft, published o completed. cancelled se rechaza.
branch_id	entero	No	—	Id numérico de una sucursal de esta organización.
from	datetime ISO 8601	No	—	Eventos cuyo inicio es mayor o igual a este valor.
to	datetime ISO 8601	No	—	Eventos cuyo inicio es menor o igual a este valor.
updated_since	datetime ISO 8601	No	—	Eventos actualizados en o después de esta marca de tiempo.
search	string	No	—	Coincidencia sin distinguir mayúsculas en el título. Máximo 200 caracteres.
sort	string	No	start_at	start_at, created_at, updated_at o title.
order	string	No	asc	asc o desc.

status se deriva del registro del evento:

Valor	Significado
draft	El evento sigue en borrador.
published	No es borrador y su fecha de fin aún está en el futuro.
completed	No es borrador y su fecha de fin ya pasó.

Las fechas deben incluir hora y zona horaria, por ejemplo 2026-09-15T09:00:00Z.

Respuesta 200

El cuerpo tiene data (lista de eventos) y pagination (page, limit, total, totalPages).

Campo	Tipo	Nulo	Descripción
id	string	No	Id del evento.
slug	string	No	Slug único dentro de la organización.
title	string	No	Título.
description	string	Sí	Descripción.
coverImage	string	No	Ruta de almacenamiento de la portada.
coverImageUrl	string	Sí	URL firmada de la portada. Expira después de una hora. null si no se puede crear.
type	string	No	in-person, online o hybrid.
visibility	string	No	public, private o invite-only.
isDraft	boolean	No	Si el evento sigue en borrador.
startDate	string	No	Inicio en ISO 8601.
endDate	string	No	Fin en ISO 8601.
timezone	string	No	Zona IANA, por ejemplo America/Monterrey.
meetingUrl	string	Sí	URL de la reunión en línea.
allowGuestsToInvite	boolean	No	Si los invitados registrados pueden invitar a otros.
showGuestList	boolean	No	Si los asistentes pueden ver la lista de invitados.
enableChat	boolean	No	Si el chat del evento está activo.
sendReminders	boolean	No	Si los recordatorios están activos.
generateWalletPass	boolean	No	Si se generan pases de wallet.
createdAt	string	No	Creación en ISO 8601.
updatedAt	string	No	Última actualización en ISO 8601.

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

Errores

Los códigos compartidos están en Autenticación. Estos son propios 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 events."
  }
}

404 sucursal desconocida

branch_id es el id numérico de la sucursal, no un UUID. Una sucursal de otra organización también responde como no encontrada:

{
  "error": {
    "code": "NOT_FOUND",
    "message": "The requested branch was not found."
  }
}

405 otros métodos

POST, PUT, PATCH y DELETE responden 405 con Allow: GET y el código METHOD_NOT_ALLOWED.