Interface ListContactQueryParams

Interface representing the query parameters for listing contacts.

Hierarchy

Properties

email? group? limit? pageToken? phoneNumber? recurse? select? source?

Properties

Optional email

email?: string

Returns the contacts matching the exact contact's email.

Optional group

group?: string

Returns the contacts belonging to the Contact Group matching this ID

Optional limit

limit?: number

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

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 phoneNumber

phoneNumber?: string

Returns the contacts matching the contact's exact phone number

Optional recurse

recurse?: boolean

When set to true, returns the contacts also within the specified Contact Group subgroups, if the group parameter is set.

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 source

source?: string

Returns the contacts matching from the address book or auto-generated contacts from emails. For example of contacts only from the address book: /contacts?source=address_bookor for only autogenerated contacts:/contacts?source=inbox`

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc