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!

Knowledge Base

Getting Started

👋 Welcome to Nylas! This will help you get started integrating the Nylas API with your application. It's packed with best practices and other important tips that will make your integration a breeze.

This guide is currently a work in progress. If you're confused about anything or something is missing, please reach out to us and we can chat!

Important info below!

To make sure your integration goes as smoothly as possible we recommend reading through each of the linked guides below. If you ever have any questions feel free to contact our support team.


How Nylas Works

To learn about how Nylas works behind the scenes check out our How Nylas Works guide. In this guide we'll cover our API and Sync architecture, data storage policies, and what you can expect from our API performance wise.

👩‍💻 Create your developer account and get your API keys

Get your developer api keys

Before you can start testing out our API you'll need to create a developer account to get your API keys. Check out this guide to get started.

✨ Common use cases

Need to find emails shared between accounts? What about the best way to send event invites to participants automatically? Check out various examples of common use cases and the best way to approach these challenges in this guide.

🔑 Authentication

There are a couple of ways you can authenticate email accounts to Nylas. In this guide, we'll cover what your options are, as well as some very important information on how you should manage Nylas access_tokens and some other common authentication issues your application should be ready to handle.

📩 Syncing Mechanisms

Should you sync mail data using Deltas, Webhooks, or Polling? Check out this guide for tradeoffs around the various ways you can pull mail data into your application. We also include important gotchas about initial sync for accounts.

🚧 Error handling and rate limiting

To build a robust integration with any API you'll need to have solid error handling, rate limiting, and retry policies in place. Check out this guide to make sure you're following industry best practices so that your application is production ready.

💵 Managing Accounts and Billing

To learn about how Nylas determines your monthly usage, how you can manage your paid accounts, and how you can see the health of your paid accounts, check out Accounts and Billing guide.

💻 SDKs

We officially support and maintain three SDKs to help integration with the Nylas APIs:

Node SDK
Python SDK
Ruby SDK

🤷‍♂️ Support

If you ever feel stuck or run into a tricky issue please let us know - we're here to help. Here's our guide on the best way to reach out to our support team.

🔒 Security and Compliance

  • SOC2
  • EU Privacy Shield
  • GDPR

Getting Started

Suggested Edits are limited on API Reference Pages

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