Interface ListEventQueryParams

Interface representing the query parameters for listing events.

Hierarchy

Properties

attendees? busy? calendarId description? end? eventType? expandRecurring? limit? location? masterEventId? metadataPair? orderBy? pageToken? select? showCancelled? start? title?

Properties

Optional attendees

attendees?: string[]

Filter for events that include the specified attendees. Not supported for virtual calendars.

Optional busy

busy?: boolean

Returns events with a busy status of true.

calendarId

calendarId: string

Specify calendar ID of the event. "primary" is a supported value indicating the user's primary calendar.

Optional description

description?: string

Return events matching the specified description. Graph: NOT supported

Optional end

end?: string

Return events ending before the specified unix timestamp. Defaults to a month from now. Not respected by metadata filtering.

Optional eventType

eventType?: EventType[]

(Google only) Filter events by event type. You can pass the query parameter multiple times to select or exclude multiple event types.

Optional expandRecurring

expandRecurring?: boolean

If 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 limit

limit?: number

The maximum number of objects to return. This field defaults to 50. The maximum allowed value is 200.

Optional location

location?: string

Return events matching the specified location.

Optional masterEventId

masterEventId?: string

Master event id if recurring events.

Optional metadataPair

metadataPair?: Record<string, unknown>

Pass in your metadata key and value pair to search for metadata.

Optional orderBy

orderBy?: string

Order results by the specified field. Currently only start is supported.

Optional pageToken

pageToken?: string

An identifier that specifies which page of data to return. This value should be taken from the NylasListResponse.nextCursor response field.

Optional select

select?: string

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.

Optional showCancelled

showCancelled?: boolean

Return 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 start

start?: string

Return events starting after the specified unix timestamp. Defaults to the current timestamp. Not respected by metadata filtering.

Optional title

title?: string

Return events matching the specified title.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc