Skip to main content

List contacts

GET 
/api/contacts

Returns the user's contacts that have an email address, gathered from all their address books in the Contacts app, for address autocompletion. Each entry is the contact as the Contacts app returns it, plus its addressBookId.

Contacts are deduplicated by email address: a contact appears once for each address not already seen, so a contact with two new addresses is listed twice. Contacts without addresses are left out.

Never fails: the result is an empty array when no Contacts app is found, the session has no platform access token, or the Contacts app cannot be reached.

Responses​

Contacts with email addresses.