Interface ListCalendersQueryParams

Interface of the query parameters for listing calendars.

Hierarchy

Properties

limit? metadataPair? pageToken? select?

Properties

Optional limit

limit?: number

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

Optional metadataPair

metadataPair?: Record<string, string>

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

Optional pageToken

pageToken?: string

An identifier that specifies which page of data to return. This value should be taken from the [ListResponse.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.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc