nylas
    Preparing search index...

    Interface ListEventQueryParams

    Interface representing the query parameters for listing events.

    interface ListEventQueryParams {
        attendees?: string[];
        busy?: boolean;
        calendarId: string;
        description?: string;
        end?: string;
        eventType?: EventType[];
        expandRecurring?: boolean;
        limit?: number;
        location?: string;
        masterEventId?: string;
        metadataPair?: Record<string, unknown>;
        orderBy?: string;
        pageToken?: string;
        select?: string;
        showCancelled?: boolean;
        start?: string;
        tentativeAsBusy?: boolean;
        title?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    attendees?: string[]

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

    busy?: boolean

    Returns events with a busy status of true.

    calendarId: string

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

    description?: string

    Return events matching the specified description. Graph: NOT supported

    end?: string

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

    eventType?: EventType[]

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

    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.

    limit?: number

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

    location?: string

    Return events matching the specified location.

    masterEventId?: string

    Master event id if recurring events.

    metadataPair?: Record<string, unknown>

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

    orderBy?: string

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

    pageToken?: string

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

    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.

    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.

    start?: string

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

    tentativeAsBusy?: boolean

    When set to false, treats tentative calendar events as busy:false. Only applicable for Microsoft and EWS calendar providers. Defaults to true.

    title?: string

    Return events matching the specified title.

    Settings

    Member Visibility

    On This Page

    Properties