contacts

ListContactsQueryParams

Bases: ListQueryParams

Interface of the query parameters for listing calendars.

Attributes:

Name	Type	Description
limit	NotRequired[int]	The maximum number of objects to return. This field defaults to 50. The maximum allowed value is 200.
page_token	NotRequired[str]	An identifier that specifies which page of data to return. This value should be taken from a ListResponse object's next_cursor parameter.
email	NotRequired[str]	Returns the contacts matching the exact contact's email.
phone_number	NotRequired[str]	Returns the contacts matching the contact's exact phone number
source	NotRequired[SourceType]	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`
group	NotRequired[str]	Returns the contacts belonging to the Contact Group matching this ID
recurse	NotRequired[bool]	When set to true, returns the contacts also within the specified Contact Group subgroups, if the group parameter is set.

Source code in nylas/models/contacts.py

class ListContactsQueryParams(ListQueryParams):
    """
    Interface of the query parameters for listing calendars.

    Attributes:
        limit (NotRequired[int]): The maximum number of objects to return.
            This field defaults to 50. The maximum allowed value is 200.
        page_token (NotRequired[str]): An identifier that specifies which page of data to return.
            This value should be taken from a ListResponse object's next_cursor parameter.
        email: Returns the contacts matching the exact contact's email.
        phone_number: Returns the contacts matching the contact's exact phone number
        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`
        group: Returns the contacts belonging to the Contact Group matching this ID
        recurse: When set to true, returns the contacts also within the specified Contact Group subgroups,
            if the group parameter is set.
    """

    email: NotRequired[str]
    phone_number: NotRequired[str]
    source: NotRequired[SourceType]
    group: NotRequired[str]
    recurse: NotRequired[bool]