Interface ImportEventQueryParams

Interface representing the query parameters for importing events.

Hierarchy

  • ImportEventQueryParams

Properties

calendarId end? max_results? page_token? select? start?

Properties

calendarId

calendarId: string

(Required) Calendar ID to import events from. "primary" is a supported value indicating the user's primary calendar. Note: "primary" is not supported for iCloud.

Optional end

end?: number

Filter for events that end at or before the specified time, in Unix timestamp format. Defaults to one month from the time of the request.

Optional max_results

max_results?: number

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

Optional page_token

page_token?: string

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

Optional select

select?: string

Specify fields that you want Nylas to return, as a comma-separated list.

Optional start

start?: number

Filter for events that start at or after the specified time, in Unix timestamp format. Defaults to the time of the request.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc