Emails
List email contacts
Changed onReturns a list of contacts from the email provider. Supported for Gmail (Google OAuth) and Microsoft (Outlook) only.
get/api/v1/emails/contacts
Request
- Base URLhttps://api1.unipile.com:13111
- AuthAPI key in header X-API-KEY
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
cursorstring
A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.
limitinteger
A limit for the number of items returned in the response. The value can be set between 1 and 250.
Example:100
account_idstring required
A filter to target items related to a certain account.
Response
OK
Changes
- warning
added the new
errors/password_reset_requiredenum value to theresponse property for the response status
- warning