/v3/grants/{grant_id}/eventsReturn all events
Returns all events on the user's calendars.
Path parameters
Query parameters
(Not supported for virtual calendars) Filter for events that include the specified attendees. This parameter accepts a comma-delimited list of email addresses.
Filter for the specified calendar ID.
(Not supported for iCloud) You can use primary to query the user's primary calendar.
Filter for events matching the specified description. The filter is case insensitive and will match partial descriptions.
Filter for events that end at or before the specified time, in seconds using the Unix timestamp format. For example, if you filter for events that end at 5:00p.m., and the calendar includes an event that runs from 4:30–5:30p.m., Nylas returns that event.
Defaults to one month from the time you make the request.
The end value cannot be earlier than start. For iCloud accounts, the difference between start
and end can't be greater than one year.
(Google only) Filter for events with the specified event type. You can pass this query parameter
multiple times to select or exclude multiple event types. For example,
event_type=default&event_type=outOfOffice returns all events that are default or OOO, and excludes
any events that are focusTime or that have a workingLocation.
If you don't specify an event type, Nylas uses default to filter for regular events that don't have
another specific type.
This parameter is deprecated. Use the Import Events endpoint instead.
When true, Nylas returns all recurring events within the specified time range, including individual
occurrences of the recurring event. Otherwise, Nylas only returns the parent event and any event
overrides (individual occurrences that have been edited) in the time range.
(Not supported for iCloud) Filter for events with the specified ical_uid. You cannot apply other
filters if you use this parameter.
The maximum number of objects to return. See Pagination for more information.
Filter for events with the specified location. The filter is case insensitive and will match partial locations.
(Not supported for iCloud) Filter for instances of recurring events with the specified master_event_id.
master_event_id is not respected by metadata filtering.
When using master_event_id to fetch recurring events with a Google grant, the order of the results will not be sorted chronologically.
Instead, Nylas returns the unchanged occurrences first, followed by the modified occurrences.
For example, if you have a recurring event with the following occurrences:
- 2025-01-01
- 2025-01-02
- 2025-01-03
But you modify the time of the second occurrence to 2025-01-02, the results will be:
- 2025-01-01
- 2025-01-03
- 2025-01-02 (modified)
Pass a metadata key/value pair (for example, ?metadata_pair=key1:value) to search for metadata
associated with objects. See Metadata for more information.
An identifier that specifies which page of data to return. You can get this value from the
next_cursor response field. See Pagination for more
information.
Specify fields that you want Nylas to return, as a comma-separated list (for example,
select=id,updated_at). This allows you to receive only the portion of object data that you're
interested in. You can use select to optimize response size and reduce latency by limiting queries
to only the information that you need.
(Not supported for iCloud or EWS) If true, Nylas includes events whose status is cancelled.
Different providers have different semantics for cancelled events:
- Google: An event is considered cancelled after a user deletes it from their calendar, until it's eventually hard-deleted and is no longer readable.
- Microsoft: An event is considered cancelled if the user is invited to an event and the organizer deletes it. The cancelled version of the event stays on the participants' calendars until they delete it manually.
Filter for events that start at or after the specified time, in seconds using the Unix timestamp format. For example, if you filter for events that start at 9:00a.m., and the calendar includes an event that runs from 8:30–9:30a.m., Nylas returns that event.
Defaults to the time that you make the request.
The start value cannot be later than end. For iCloud accounts, the difference between start
and end can't be greater than one year.
Filter for events that match the specified title. The filter is case insensitive and will match partial titles.
(Google, Microsoft, and EWS only) Filter for events that have been updated after the specified time, in seconds using the Unix timestamp format.
updated_after is not respected by metadata filtering.