Calendar API
The Aurinko Calendar API offers a unified REST interface for managing calendars across Google, Outlook, iCloud & more. Access events, sync data, and simplify scheduling workflows.
Aurinko Calendar API
The Aurinko Calendar API is part of the Aurinko Unified API platform, enabling developers to integrate calendar functionalities effortlessly into their applications. This API abstracts the differences between calendar management services such as Google, Outlook, iCloud Calendar, offering a consistent interface for calendar-related operations.
Functionality
The Aurinko Calendar API provides a REST interface that focuses on accessing and syncing calendars uniformly.
Access data for calendars and events, such as event titles, location, description, dates, ...
Full CRUD (create, read, update, delete) capabilities.
Incremental synchronization
Aurinko account setup
First, create your account in the Aurinko portal, then follow the guide to get your developer API keys.
Calendar API Endpoints
Calendars
Each account connected to Aurinko can have zero or more calendars, and each calendar contains a collection of individual events. Accounts can have many calendars including a primary calendar, secondary calendars, read access calendars, and shared team calendars.
Events
Events are objects within a calendar that generally support all features and attributes of modern scheduling apps like event names, list of participants, descriptions, location, time, etc. Aurinko supports key event functionality, including sending email invites, response status checks and notifications, creating and modifying events, and recurring events.
Synchronization
Calendar sync methods allow developers to implement incremental synchronization of calendar data in a uniform manner across different calendar providers. Aurinko supports requesting updated as well as deleted calendar events, reporting series master and exceptions, auto-expanding a sync range.
Free/busy schedule
Free/busy schedule methods allow developers to check free/busy status for a calendar or available time slots for a meeting.
Booking profiles
Booking profiles methods allow developers to build calendar availability and meeting scheduling apps. List, create, update, and delete booking profiles associated with a user calendar. See meeting time availability according to a booking profile configuration.
Calendar sync quickstart
Start a new sync
A new sync needs to be provisioned by calling the sync-start method /calendars/{calendarId}/sync
The sync is available per calendar, hence {calendarId} or primary. timeMin
and timeMax
specify a time range for the initial full load.
The Aurinko platform will initialize all necessary internal resources and let you know when it's ready to serve data. The response should look like this:
If the response shows ready: false
call the sync-start method again. Once the sync is ready you will get delta tokens syncUpdatedToken
, syncDeletedToken
and can start loading updated and deleted events.
Initial full sync
Initial requests /calendars/{calendarId}/sync/updated
and /calendars/{calendarId}/sync/deleted
are equivalent to a full sync in the specified timeMin
, timeMax
range, plus loading all updated events (deleted events) since the sync start.
Response:
Continue loading pages using provided nextPageToken
until you find another nextDeltaToken
.
Incremental sync
A new deltaToken (nextDeltaToken in response) is provided for loading calendar events that have been modified/deleted since the last sync-updated/sync-deleted request. In cases where a large number of events have changed since the last incremental sync request, you may find a nextPageToken
instead of the nextDeltaToken
in the response. Continue loading pages using the provided nextPageToken
until you find another nextDeltaToken
.
Other examples
Calendars
To view a list of all calendars a user has access to, make a request to the /calendars
endpoint.
You can get information for a single calendar by providing the appropriate calendar id, /calendars/{id}
. You can use primary as an ID to get your primary calendar.
Calendar events
To get a list of events from a calendar, make a request to the /calendars/{id}/events
endpoint.
To create a new meeting POST json payload to /calendars/{id}/events
endpoint:
Use PATCH request to update existing events and notify meeting attendees of changes:
Last updated