nylas api contacts get
Return All Contacts
Options
| Name | Description |
|---|---|
--country <country> | Returns the contacts matching the contact's exact physical addresses |
--display_columns <headers> | (optional) A comma separated list of column headers to display for the table output |
--email <email> | Returns the contacts matching the exact contact's email |
--group <group> | Returns the contacts belonging to the Contact Group matching this ID |
--limit <limit> | The number of objects to return. Defaults to 100. If set too high, requests may fail to prevent excessively large response bodies |
--offset <offset> | Zero-based offset from default object sorting. See [pagination](/docs/api/#overview--pagintaion) for more information |
--phone_number <phone_number> | Returns the contacts matching the contact's exact phone number |
--postal_code <postal_code> | Returns the contacts matching the contact's exact postal code of one of the contact's addresses |
--source <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_book` or for only autogenerated contacts: `/contacts?source=inbox` |
--state <state> | Returns the contacts matching the contact's exact state for one of the contact's physical addresses |
--street_address <street_address> | Returns the contacts matching the one of the contact's exact street address |