GET
/api/v1/calendar-eventsGet calendar events
Retrieve a paginated list of calendar events with optional filtering
Authentication
Send your API key in the x-api-key header.
x-api-keybearer
Parameters
startDatequery · string
Filter calendar events by start date
endDatequery · string
Filter calendar events by end date
calendarIdquery · string
Filter calendar events by calendar ID
statusquery · string
Filter calendar events by status
pagequery · string
Page number
limitquery · string
Number of items per page
Responses
200Calendar events retrieved successfully
PublicApiGetCalendarEventsResponseDto
statusCoderequirednumber
countrequirednumber
errorrequiredstring
datarequiredarray<PublicApiCalendarEventDto>
Example response
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://meet.google.com/abc123def456"
}
},
"metadata": {
"customField": "value"
},
"createdAt": "2024-07-15T09:00:00.000Z",
"updatedAt": "2024-07-15T09:30:00.000Z"
}
]
}
401Unauthorized - missing or invalid API key or Bearer token