Only show these results:

Quickstart

In this guide, you'll learn how to connect an email account to your Nylas account and make your first API request.

Requirements

Step 1: Connect an email account

Connect an email account to your Nylas account. You can either connect a Nylas test email account or your own email account.

  • For a Nylas test email account, read-only authentication scopes are enabled.
  • For your email account, all authentication scopes are enabled.

Learn more about authentication scopes.

Authentication scopes Nylas test email account Your email account
email.modify X
email.read_only X X
email.metadata X
email.drafts X
email.send X
email.folders_and_labels X
calendar X
calendar.read_only X X
contacts X
contacts.read_only X X
room_resources.read_only X X
Connect an email account

Connect a Nylas test email account

Using the test email account, you can test Nylas's read functionalities.

  1. Log in to Nylas Dashboard.
  2. On the Quickstart page, click Use a Nylas test account.
    A test email is automatically generated.
  3. Click Connect.

Connect your own email account

Using your own email account, you can test Nylas's full functionalities. Your email service provider might ask you to grant Nylas access to the account's calendars, contacts, and email.

  1. Log in to Nylas Dashboard.
  2. On the Quickstart page, click Use my own account.
  3. Enter your email address.
  4. Review required permissions.
  5. Click Next.

Step 2: Run the sample API request

When you connect an email account, Nylas provides the following information:

Ensure that you save the access token in a safe place. You can't view the access token again after you leave the page.

  • Client ID
  • Client secret
  • Access token

Using the access token, run the sample API request (GET /account) that returns your account details. You can use either cURL or the Nylas CLI.

Client ID, client secret, and access token. Run the sample API request.

Use cURL

  1. Under Give it a try, from the dropdown list, select CURL.
  2. Do one of the following:
    • Click Run.
    • Click Copy and run the request in your terminal.

In the response, you can see your account details.

Use the Nylas CLI

The Nylas CLI enables developers to authenticate accounts, make API requests, and test webhooks from the terminal. Learn more about the Nylas CLI.

  1. Under Give it a try, from the dropdown list, select Nylas CLI.
  2. Follow the instructions on the screen.

Step 3: Explore Nylas's use cases

From the navigation menu, click Playground to explore Nylas's use cases.

What's Next?