Nylas Calendar API Overview
The Nylas Calendar API powers your application with a secure, reliable connection to your user’s calendars. Sync historic and live events into your application in real-time.
The Nylas Calendar API provides a REST interface that includes functionality to:
- Access data for calendars and events, such as event titles, location, description, dates, and more.
- Schedule events, send notifications, and RSVP to existing events.
What Is a Calendar?
Each account connected to Nylas can have zero or more calendars, and each calendar has a collection of individual events. The calendar object is very simple and mostly serves as a container for events.
Types of Calendars
Provider
The primary calendar of the account is usually using the same name as the email address, or is sometimes simply called "Calendar." Users may also have other custom calendars, access to colleagues' calendars, or access to shared team calendars. See Events for more details.
Events can be viewed, added, modified, and deleted on calendars where read_only is false. Changes are automatically synced back to the provider.
IMAP Not Supported
- IMAP is not supported by Google or Microsoft.
- IMAP does not support calendar features.
Use the Detect Provider endpoint to check if we can connect to your provider automatically. If not, then you need to enter manual IMAP settings.
Emailed Events
All accounts also include a special calendar called "Emailed events" which contains event invitations that have been sent to the user's mailbox. This calendar is read-only, meaning events cannot be added, updated, or deleted. However, the events can handle RSVPs. See the Events documentation for details.
Virtual Calendars
Virtual Calendars are used when you need to schedule people or objects that do not have an associated calendar. Review the Virtual Calendar documentation to learn more.
Calendar API Endpoints
This section covers all of the endpoints the Nylas Calendar API provides to enable you to integrate full calendar functionality into your app.
Calendars
Each account connected to Nylas can have zero or more calendars, and each calendar contains a collection of individual events. Accounts can have many calendars including a primary calendar, shared team calendars, read access to colleagues' calendars, and other custom calendars. Calendars that are associated with email accounts typically have a primary calendar for the user's email, as well as an emailed events calendar that contains events that have been sent to a user's email inbox.
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. Nylas supports all event functionality you expect, including sending email invites, RSVP status checks, notifications, creating events, modifying events, and recurring events.
Powered by Calendar
The Nylas products that use calendar.
Scheduler
The Nylas Scheduler is the fastest way to add full calendar functionality to your application, allowing your users to create highly-customizable scheduling pages. Now attendees and organizers can easily view availability and book meetings using your application without needing third-party scheduling solutions.
Virtual Calendar
Virtual Calendars work like any other calendar and make it easy to embed customized scheduling functionality into your application. They're ideal for situations where you need to schedule events for people or objects that aren’t associated with an existing calendar account. Virtual Calendars allow you to provide scheduling functionality to your users without requiring them to connect a third-party service provider like Google, Exchange, or Office 365.
Agenda
Use the Agenda Component to display calendar data. Quickly embed UI components into your application without needing to build from scratch.