← Volver al listado
GET/api/v1/calendar-events

Obtener eventos del calendario

Recuperar una lista paginada de eventos del calendario con filtrado opcional

Autenticación

Envía tu API key en el header x-api-key header.

x-api-keybearer

Parámetros

startDate

query · string

Filter calendar events by start date
endDate

query · string

Filtrar eventos del calendario por fecha de fin
calendarId

query · string

Filtrar eventos del calendario por ID de calendario
status

query · string

Filtrar eventos del calendario por estado
page

query · string

Número de página
limit

query · string

Número de elementos por página

Respuestas

200Eventos del calendario recuperados exitosamente

PublicApiGetCalendarEventsResponseDto

statusCoderequired

number

countrequired

number

errorrequired

string

datarequired

array<PublicApiCalendarEventDto>

Ejemplo de respuesta

json
{
  "statusCode": 200,
  "count": 0,
  "error": null,
  "data": [
    {
      "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
      "calendarId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
      "title": "Team Meeting",
      "description": "Weekly team standup meeting",
      "startDateTime": "2024-07-15T10:00:00.000Z",
      "endDateTime": "2024-07-15T11:00:00.000Z",
      "location": "Conference Room A",
      "status": "confirmed",
      "visibility": "default",
      "organizerEmail": "organizer@example.com",
      "organizerName": "John Doe",
      "busy": true,
      "readOnly": false,
      "hideParticipants": false,
      "htmlLink": "https://calendar.google.com/event?eid=...",
      "iCalUID": "event123@google.com",
      "nylasId": "nylas_event_123",
      "masterEventId": "master_event_123",
      "duration": 3600,
      "recurrence": [
        "FREQ=WEEKLY;BYDAY=MO"
      ],
      "participants": [
        {
          "email": "john.doe@example.com",
          "name": "John Doe",
          "status": "yes"
        }
      ],
      "conferencing": {
        "provider": "Zoom Meeting",
        "details": {
          "url": "https://zoom.us/j/91288944390?pwd=1234567890"
        }
      },
      "metadata": {
        "customField": "value"
      },
      "createdAt": "2024-07-15T09:00:00.000Z",
      "updatedAt": "2024-07-15T09:30:00.000Z"
    }
  ]
}
401No autorizado - clave API o token Bearer faltante o inválido