nylas/com.nylas.models/ListContactsQueryParams

ListContactsQueryParams

public final class ListContactsQueryParams implements IQueryParams

Class representation of the query parameters for listing calendars.

Constructors

public ListContactsQueryParams ListContactsQueryParams(@Json(name = "limit") Integer limit, @Json(name = "page_token") String pageToken, @Json(name = "email") String email, @Json(name = "phone_number") String phoneNumber, @Json(name = "source") SourceType source, @Json(name = "group") String group, @Json(name = "recurse") Boolean recurse)

Types

Builder

public final class Builder

Properties

private final String email

Returns the contacts matching the exact contact's email.

group

private final String group

Returns the contacts belonging to the Contact Group matching this ID

limit

private final Integer limit

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

pageToken

private final String pageToken

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

phoneNumber

private final String phoneNumber

Returns the contacts matching the contact's exact phone number

recurse

private final Boolean recurse

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

source

private final SourceType source

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`