Version:
Only show these results:

Calendar and Events scopes

This page lists the Calendar and Events API endpoints and notification triggers available in Nylas v3, and shows which scopes they require. For more information about scopes in Nylas v3, see the Authentication scopes documentation.

All scopes must include the fully qualified URI path for the provider. The table shortens the full scope URI for space reasons, so add the prefix for the provider when requesting scopes.

The ☑️ in each column indicates the most restrictive scope you can request for each provider and still use that API. More permissive scopes appear under the minimum option. If you're already using one of the permissive scopes, you don't need to add the more restrictive scope.

Calendar and Events API scopes

EndpointGoogle Scopes
https://www.googleapis.com/auth/...
Microsoft Scopes
https://graph.microsoft.com/...

GET /calendars
GET /calendars/<CALENDAR_ID>
POST /calendars/free-busy

/calendar.readonly ☑️
/calendar

Calendars.Read ☑️
Calendars.ReadWrite

POST /calendars
PUT /calendars/<CALENDAR_ID>
DELETE /calendars/<CALENDAR_ID>

/calendar ☑️

Calendars.ReadWrite ☑️

POST /calendars/availability

/calendar.readonly ☑️
/calendar

Calendars.Read ☑️
Calendars.ReadWrite

GET /events
GET /events/<EVENT_ID>

/calendar.events.readonly ☑️
/calendar.events
/calendar (Required to use primary keyword when referencing calendars.)

Calendars.Read ☑️
Calendars.ReadWrite

POST /events
PUT /events/<EVENT_ID>
DELETE /events/<EVENT_ID>
POST /events/<EVENT_ID>/send-rsvp

/calendar.events ☑️
/calendar (Required to use primary keyword when referencing calendars.)

Calendars.ReadWrite ☑️

GET /v3/grants/<NYLAS_GRANT_ID>/resources

/admin.directory.resource.calendar.readonly ☑️️

Place.Read.All ☑️️

Automatic conferencing creation

Microsoft Teams: OnlineMeetings.ReadWrite.
Google Meet: No extra scopes required. Conferencing is part of the Event object.
Zoom: meeting:write:meeting and user:read:user.

Calendar and Events notification scopes

Notification triggerGoogle Scopes
https://www.googleapis.com/auth/...
Microsoft Scopes
https://graph.microsoft.com/...

calendar.created
calendar.updated
calendar.deleted

/calendar.events.readonly ☑️
/calendar.events

Calendars.Read ☑️
Calendars.Read.Shared
Calendars.ReadWrite
Calendars.ReadWrite.Shared

event.created
event.updated
event.deleted

/calendar.events.readonly ☑️
/calendar.events

Calendars.Read ☑️
Calendars.Read.Shared
Calendars.ReadWrite
Calendars.ReadWrite.Shared

For more information about Calendar and Events notifications, see the Calendar and Events notification schemas.