How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nylas Events API

Events. Create, update, delete and list calendar events, including recurring events, group events and RSVP handling.

Nylas Events API is one of 13 APIs that Nylas publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Event. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 13 operations across 8 paths, and defines 46 schemas. It is described by OpenAPI 3.2.0, at version v3.

Requests are made against 2 base URLs: https://api.us.nylas.com, https://api.eu.nylas.com.

13 operations 8 paths 46 schemas 2 DELETE4 GET5 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v3
Base URL
https://api.us.nylas.com
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Nylas Events API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (NYLAS_ACCESS_TOKEN) (ACCESS_TOKEN). It accepts HTTP bearer tokens (NYLAS_API_KEY) (NYLAS_API_KEY). By default, every request must be authenticated.

  • ACCESS_TOKEN — The Nylas access token for a specific grant. Issued as part of OAuth 2.1 flow token exchange.
  • NYLAS_API_KEY — The Nylas API key provides application-level access to APIs and all grants. You can generate these from the Dashboard. Learn more about [authorizing requests](…

Paths & Operations 13

Across 8 paths, the API surfaces 13 operations — 2 DELETE, 4 GET, 5 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Events 13
GET
/v3/grants/{grant_id}/events
Return all events
get-all-events 21 params → 200400401429504
POST
/v3/grants/{grant_id}/events
Create an event
create-event 5 params body → 200400401429504
GET
/v3/grants/{grant_id}/events/import
Import events
import-events 7 params → 200400401429504
GET
/v3/grants/{grant_id}/events/{event_id}
Return an event
get-events-id 5 params → 200400401404429504
PUT
/v3/grants/{grant_id}/events/{event_id}
Update an event
put-events-id 6 params body → 200400401404429504
DELETE
/v3/grants/{grant_id}/events/{event_id}
Delete an event
delete-events-id 4 params → 200400401404429504
POST
/v3/grants/{grant_id}/events/{event_id}/send-rsvp
Send RSVP
send-rsvp 4 params body → 200400401429504
GET
/v3/grants/{grant_id}/scheduling/configurations/{configuration_id}/group-events
Get all group events
get-group-events 5 params → 200400401429504
POST
/v3/grants/{grant_id}/scheduling/configurations/{configuration_id}/group-events
Create group event
create-group-event 2 params body → 200400401429504
PUT
/v3/grants/{grant_id}/scheduling/configurations/{configuration_id}/group-events/{event_id}
Update a group event
put-group-event 3 params body → 200400401404429504
DELETE
/v3/grants/{grant_id}/scheduling/configurations/{configuration_id}/group-events/{event_id}
Delete a group event
delete-group-event 3 params → 200400401404429504
POST
/v3/scheduling/configurations/{configuration_id}/import-group-events
Import group events
import-group-events 1 param body → 200
POST
/v3/scheduling/configurations/{configuration_id}/group-events/validate-timeslot
Validate time slot
validate-time-slot 1 param body → 200

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are event_common (28 properties), event_create (15 properties), group_event (9 properties), meeting_settings_common (8 properties). Each schema is shown below with its type and property counts.

event_resources
object
Resources are physical locations or equipment that can be reserved for events, and which are tracked using an email address with an associated calendar.
2 properties 1 required
event_status
string
(Not supported for iCloud) The status of the event. You can't set this field when creating or updating an event. If you're the organizer of the event and you w…
object
string
The type of object.
event_updated_at
integernull
When the event was last updated, in seconds using the Unix timestamp format.
event_ical_uid
stringnull
A unique ID that you can use to identify events across calendaring systems, in [iCalendar format](https://datatracker.ietf.org/doc/html/rfc5545section-3.8.4.7)…
event
group_event_recurrence
array
An array of RRULE and EXDATE strings. Nylas includes this field only if the event is the main (master) event. See [RFC-5545](https://tools.ietf.org/html/rfc554…
event_capacity
integer
The maximum number of participants that can attend the event.
event_conferencing_response
object
An object that contains event conferencing details. Nylas appends the conference information to the Event description.
1 property
event_when_response
objectnull
An object that represents the time and duration of an event. Nylas might format when as one of three sub-objects: timespan, date, or datespan. These sub-object…
event_visibility
stringnull
(Not supported for iCloud events) Specifies whether the event is public or private. If not defined, Nylas uses the account's default provider settings. For Goo…
event_reminders_create
object
A list of reminders to send for the event. If left empty or omitted, the event uses the provider defaults.
2 properties
event_participants_create_update
object
4 properties 1 required
event_location
string
The location of the event (for example, a physical address or the name of a meeting room).
event_send_rsvp
object
1 property
event_busy
booleannull
When true, shows the event's time block as "busy" on shared or public calendars. This might be called "transparency" in some systems. This field may be null if…
meeting_settings
event_datespan
object
A span of days, without specific clock-based start and end times (for example, a business quarter or semester). For more information, see [All-day event handli…
2 properties
event_reminders
object
A list of reminders to generate for the event. If not defined, Nylas uses the provider's default settings.
2 properties
event_sync
object
3 properties
event_conferencing_request
object
An object that lets you automatically create a conference, or enter conferencing details manually. You can't use autocreate and details in the same request. If…
event_recurrence
array
An array of RRULE and EXDATE strings. Nylas includes this field only if the event is the main (master) event. See [RFC-5545](https://tools.ietf.org/html/rfc554…
event_created_at
integernull
When the event was created, in seconds using the Unix timestamp format.
event_description
string
A brief description of the event (for example, its agenda). Nylas might return the description as an HTML string, depending on how the provider formats it. For…
grant_id
string
The ID of grant for the connected user.
event_title
string
The name of the event.
metadata
object
The metadata associated with the object. For more information, see [Metadata](/docs/reference/api/metadata).
event_date
object
The date on which the event occurs, without a clock-based start or end time (for example, a birthday or holiday).
1 property
event_read_only
boolean
If true, indicates that the event is read-only. The provider sets the readonly value based on the connected calendar, and you can't modify it. In cases where y…
event_html_link
string
(Not supported for EWS events) A link to the event on the provider.
group_event
object
9 properties 4 required
event_participants
array
An array of participants invited to the event. The organizer doesn't need to be explicitly included in this list.
event_when
object
An object that represents the time and duration of an event. You can format when as one of four sub-objects: time, timespan, date, or datespan. These sub-objec…
event_create
object
15 properties 1 required
group_event_participants
object
An array of participants to include in the event booking. If you don't specify at least one participant, Nylas uses the event organizer instead.
3 properties 1 required
import-group-event-response
object
2 properties
event_common
object
28 properties
event_time
object
A specific point in time (for example, the start time of an event).
2 properties
event_hide_participants
boolean
When true, hides the event's list of participants.
common_response_with_cursor
object
3 properties
event_calendar_id
stringnull
The calendar ID associated with the event. If you used the calendarid=primary query parameter in your request, Nylas returns the real calendar ID instead of pr…
organizer
object
An object that contains information about an event's organizer.
2 properties
common_response
object
2 properties
event_timespan
object
A period of time with a specified beginning and end (for example, an hour-long lunch meeting).
4 properties
event_id
string
The ID of the event. Event IDs are usually unique to each user, except for Google which maintains the same event ID for an event regardless of the user queryin…
meeting_settings_common
object
A collection of settings for the Notetaker bot.
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nylas-events-api-openapi.yml Raw ↑

Other APIs Nylas publishes across the network.

Nylas Admin API
Nylas Auth API
Nylas Calendars API
Nylas Contacts API
Nylas Drafts API
Nylas Grants API
Nylas Messages API
Nylas Scheduling API
Nylas Threads API
Nylas Notifications API
Nylas Notetaker API
Nylas Templates and Workflows API
Where this information came from

This is an independent, third-party profile of Nylas Events API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.