Nylas Docs

The Nylas Developer Hub

Welcome to the Nylas developer hub. You'll find comprehensive guides and documentation to help you start working with Nylas as quickly as possible, as well as support if you get stuck. Let's jump right in!

Developer Guide

Contacts API

Learn about the Nylas Contacts API

The Nylas Contacts API powers your application with a secure, reliable connection to your user’s contacts. Contact details update in real-time, so your users always have the most recent, accurate data. Get bi-directional contacts sync and full CRUD (create, read, update, delete) capabilities from Google Contacts, Microsoft Exchange Contacts, iCloud, Outlook.com contacts with just a few lines of code.

The Nylas Contacts API provides a REST interface that includes functionality to

  • Read data for a user’s contacts including name, email, phone number, notes, and more.
  • Create new contacts and modify existing contacts.

Endpoints

This section covers all of the endpoints the Nylas Contacts API provides to enable you to integrate full contacts book functionality into your app.

Contacts

The Contacts endpoint provides access to the user's contacts, making it easy to add contact autocomplete, address book integration, and more to your application.

Other Features of the Nylas Contacts API

The Nylas Communications Platform provides other functionality that makes it easy for you to build your contacts integration.
Filtering allow you to narrow requests based on specific parameters like email or street address, phone numbers, and location. Filters help you reduce the size of your API requests, resulting in faster performance.
Pagination makes it possible to control the number of results that are returned.
Webhooks allow your application to receive notifications when contacts are created, updated, or deleted.
Deltas enable you to process new data quickly without fetching an index of the user's contacts book or performing a large number of API calls.

Next Steps

How Nylas Works - Take a look at the Nylas architecture to see how we enable you to build your contacts book integration.

Quickstart Guides - Get up to speed quickly with our SDKs using our quickstart guides for Python and Node.js, or explore the Nylas Email or Calendar API.

Tutorials - Check out our plethora of tutorials to learn how to carry out common email, calendar, and contacts functionality.

Integration Guides - Ready to start building your integration? Our integration guides cover what it takes to incorporate contacts functionality into your app. They cover best practices for using the Nylas Communications Platform and provider-specific advice for Google, Microsoft, and more.

Set up Postman - Postman makes it easy to explore the Nylas Contacts API.

API Reference - Our API reference provides all the detail you need to know to use the Nylas Communications Platform.

Updated 10 days ago

Contacts API


Learn about the Nylas Contacts API

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.