Interface ListNotetakersQueryParams

Interface representing the query parameters for listing notetakers.

Hierarchy

Properties

joinTimeEnd? joinTimeStart? limit? orderBy? orderDirection? pageToken? prevPageToken? select? state?

Properties

Optional joinTimeEnd

joinTimeEnd?: number

Filter for Notetaker bots that have join times that end at or are before a specific time, in Unix timestamp format.

Optional joinTimeStart

joinTimeStart?: number

Filter for Notetaker bots that have join times that start at or after a specific time, in Unix timestamp format.

Optional limit

limit?: number

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

Optional orderBy

orderBy?: "name" | "join_time" | "created_at"

The field to order the Notetaker bots by.

Default

created_at

Optional orderDirection

orderDirection?: "desc" | "asc"

The direction to order the Notetaker bots by.

Default

asc

Optional pageToken

pageToken?: string

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

Optional prevPageToken

prevPageToken?: string

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

state?: NotetakerState

Filter for Notetaker bots with the specified meeting state.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc