Nylas Docs

The Nylas Developer Hub

Welcome to the Nylas developer hub. You'll find comprehensive guides and documentation to help you start working with Nylas as quickly as possible, as well as support if you get stuck. Let's jump right in!

Developer Guide

Calendar API

Learn about the Nylas Calendar API

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. Get bi-directional calendar sync with Google Calendar, Exchange Calendar, and Outlook.com calendars with just a few lines of code, as well as reading and responding to iCal invitations.

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.

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.

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 would expect, including sending email invites, RSVP status checks and notifications, creating and modifying events, and recurring events.

Ready to Build With The Nylas Calendar API?

Other Features of the Nylas Calendar API

The Nylas Communications Platform provides other functionality that makes it easy for you to build your calendar integration.

Filtering allow you to narrow requests based on specific parameters like event titles, locations, and start and end time. Filters help you reduce the size of your API requests which results in faster performance.

Pagination makes it possible to control the number of results that are returned.

Webhooks allow your application to receive notifications when certain events occur such the creation or update of calendars and events.

Deltas enable you to process new data quickly without fetching an index of the user's calendar or performing a large number of API calls.

Next Steps

How Nylas Works - Take a look at the Nylas architecture to see how we sync billions of events.

Quickstart Guides - Get up to speed quickly with our SDKs using our quickstart guides for Python and Node.js, or explore the Nylas Email or Contacts API.

Tutorials - Check out our plethora of tutorials to learn how to carry out common functionality, like creating new events, sending email invitations, and RSVPing to events.

Integration Guides - Ready to start building your integration? Our integration guides cover what it takes to incorporate calendar functionality into your app. They cover best practices for using the Nylas Communications Platform and provider-specific advice for Google, Microsoft, and more.

Set up Postman - Postman makes it easy to explore the Nylas Calendar API.

API Reference - Our API reference provides all the detail you need to know to use the Nylas Communications Platform.

Updated 3 days ago

Calendar API


Learn about the Nylas Calendar API

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.