List calendar events
GET/v2/calendar/events
Returns all calendar events, paginated and filtered by the date.
Request
Query Parameters
How many records to show per page in the range [1, 100]. Defaults to 25
The current page to fetch results from. Defaults to 1
Whether to include total_pages and total_count in the metadata. Defaults to false
Key to sort on, must be one of: start_time. Defaults to start_time
Direction to sort in, must be one of: ASC, DESC. Defaults to DESC
Lower bound (inclusive) for a calendar event's end time to filter by. Must be in ISO 8601 format.
Example: 2022-02-14T10:12:59+00:00
.
Upper bound (exclusive) for a calendar event's start time to filter by. Must be in ISO 8601 format.
Example: 2022-02-14T10:12:59+00:00
.
user_guid of the user who created or included as a guest to the event.
Responses
- 200
Success
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- ]
User GUID of the user calendar.
Last modification time of the calendar event.
Title of the calendar event
Tenant ID of the user calendar
The status of the calendar event. It can be empty for non-google events.
The (inclusive) start time of the calendar event.
Specifies how often a recurring event repeats (Daily, Weekly, Monthly, Yearly). This field is omitted for single events or instances of recurring events.
Whether the calendar event is a recurring event.
List of RRULE for a recurring event, as specified in RFC5545. This field is omitted for single events or instances of recurring events.
The provider of the calendar event.
The organizer email of the calendar event.
Location of the calendar event
The timestamp of the last occurrence in a series of recurring events.
The calendar event original ID from calendar provider
Calendar event unique identifier (iCalUID)
An absolute link to this calendar event in the Google Calendar Web UI.
Extended properties of the calendar event.
The (exclusive) end time of the calendar event.
Description of the calendar event
The creator email of the calendar event.
Creation time of the calendar event.
The conference-related information, such as details of a Google Meet conference.
The canceled date of the calendar event.
Calendar ID of the user calendar.
Busy/free status of the calendar event
Raw body content from Microsoft calendar events
attendees object[]
The attendees of the calendar event.
Whether the calendar event is an all-day event.
[
{
"user_guid": "9ccb7701-52e7-4d3e-91b0-b142a2fef2ec",
"updated_at": "2024-06-27T22:15:58.276090Z",
"title": "Calendar event title",
"tenant_id": 1,
"status": "confirmed",
"start_time": "2024-06-27T22:15:58.275670Z",
"recurring_interval": "Daily",
"recurring": false,
"recurrence": [
"RRULE:FREQ=DAILY;INTERVAL=1"
],
"provider": "google",
"organizer": "organizer@example.com",
"location": "Event location",
"last_occurrence_at": "2024-06-27T22:15:58.276194Z",
"id": "AAMkADQ0NjE4YmY5LTc3ZDYtNDc5NC1-UlgAAAAAAENAAB3eGoN5TIDTp8dXXDpxUlgAACQlfLuAAA=",
"i_cal_uid": "1p1oilmc4mt3m6ah6rmf6ik8mm@google.com",
"html_link": "https://www.google.com/calendar/event?eid=Y2N",
"extended_properties": {},
"end_time": "2024-06-27T22:15:58.275752Z",
"description": "Calendar event description",
"creator": "creator@example.com",
"created_at": "2024-06-27T22:15:58.276028Z",
"conference_data": {},
"canceled_at": "2024-06-27T22:15:58.276141Z",
"calendar_id": "test@example.com",
"busy": false,
"body_html": "some html text",
"attendees": [
{
"status_changed": false,
"status": "accepted",
"organizer": true,
"name": "Alice",
"email": "alice@example.com",
"deleted_at": null
},
{
"status_changed": false,
"status": "accepted",
"organizer": false,
"name": "Bob",
"email": "bob@example.com",
"deleted_at": null
}
],
"all_day": false
}
]