Optional
attendeesFilter for events that include the specified attendees. Not supported for virtual calendars.
Optional
busyReturns events with a busy status of true.
Specify calendar ID of the event. "primary" is a supported value indicating the user's primary calendar.
Optional
descriptionReturn events matching the specified description. Graph: NOT supported
Optional
endReturn events ending before the specified unix timestamp. Defaults to a month from now. Not respected by metadata filtering.
Optional
event(Google only) Filter events by event type. You can pass the query parameter multiple times to select or exclude multiple event types.
Optional
expandIf true, the response will include an event for each occurrence of a recurring event within the requested time range. If false, only a single primary event will be returned for each recurring event. Cannot be used when filtering on metadata. Defaults to false.
Optional
limitThe maximum number of objects to return. This field defaults to 50. The maximum allowed value is 200.
Optional
locationReturn events matching the specified location.
Optional
metadataPass in your metadata key and value pair to search for metadata.
Optional
orderOrder results by the specified field. Currently only start is supported.
Optional
pageAn identifier that specifies which page of data to return. This value should be taken from the NylasListResponse.nextCursor response field.
Optional
showReturn events that have a status of cancelled. If an event is recurring, then it returns no matter the value set. Different providers have different semantics for cancelled events.
Optional
startReturn events starting after the specified unix timestamp. Defaults to the current timestamp. Not respected by metadata filtering.
Optional
titleReturn events matching the specified title.
Generated using TypeDoc
Interface representing the query parameters for listing events.