Contacts API
Aurinko's Contacts API offers a RESTful interface for syncing contacts from Google, Office 365, and more. Enjoy features like CRUD operations, incremental sync, and detailed contact information access
Aurinko Contacts API
The Aurinko Contacts API abstracts away differences between popular contacts APIs (Google, Office 365, Outlook.com, MS Exchange) to make it easy to develop calendar integrations.
The Aurinko Contacts API provides a REST interface that focuses on accessing and address books in a uniform manner.
Access data for contacts, such as event titles, location, description, dates, ...
Full CRUD (create, read, update, delete) capabilities.
Incremental synchronization
Read data for a user’s contacts including name, email, phone number, notes, and more.
Create new contacts and modify existing contacts.
Aurinko account setup
First, create your account in the Aurinko portal, then follow the guide to Get Your Developer API Keys.\
Contacts API Endpoints
Contacts
Contacts are objects within an address. Aurinko supports key contacts functionality, making it easy to add address book integrations.
Synchronization
Contacts sync methods allow developers to implement incremental synchronization of contacts data in a uniform manner across different address providers. Aurinko supports requesting updated as well as deleted calendar events, reporting series master and exceptions, auto expanding a sync range.
Contacts sync quickstart
Start a new sync
A new sync needs to be provisioned by calling the "sync start" method /contacts/sync
.
The Aurinko platform will initialize all necessary internal resources and let you know when it's ready to serve data. The response should look like this:
If the response shows ready: false
call the "sync start" method again. Once the sync is ready you will get delta tokens syncUpdatedToken
, syncDeletedToken
and can start loading updated and deleted contacts.
Initial full sync
Initial requests /contacts/sync/update
d
and /contacts/sync/deleted
are equivalent to a full sync, plus loading all updated contacts (deleted contacts) since the sync start.
Response:
Continue loading pages using provided nextPageToken
until you find another nextDeltaToken
.
Incremental sync
A new deltaToken (nextDeltaToken in a response) is provided for loading contacts that have been modified/deleted since the last sync-updated/sync-deleted request. In cases where a large number of contacts have changed since the last incremental sync request, you may find a nextPageToken
instead of the nextDeltaToken
in the response. Continue loading pages using the provided nextPageToken
until you find another nextDeltaToken
.
Other examples
To create a new contact POST json payload to /contacts
endpoint:
Use PATCH request to update existing contacts. List only those high level fields that are being updated, and specify If-Match
header with the ETag
value that was received when you loaded the contact.
Last updated