Only show these results:

Quick Start

Our quick start is the fastest way to start using Nylas. If you are a first-time user sign up for an account at Nylas and follow the on-screen instructions. We'll get your account connected and start to sync your data.

After we finish syncing your account data, you’ll be taken to our welcome page. It has your access token, which you’ll need to make API requests. From there you can explore some of the Nylas products or jump into one of the beginner guides listed.

Quick start landing page

Only one connected account at a time

We only allow one connected account when using the Quickstart app. If you need to connect multiple accounts, create a new app.

Where to Begin

Start with one of our beginner guides to start making the most of Nylas.

Make Your First API Request

Let's return any unread messages.

curl --location --request GET 'https://api.nylas.com/messages?limit=100&unread=true' \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
}

If everything is set up properly, you should see a response similar to the following example.

[
{
"account_id": "{account_id}",
"bcc": [
{
"email": "Albert Einstein",
"name": "al@particletech.com"
}
],
"body": "<html>\\n<head>\\n <meta charset=\\\"UTF-8\\\">\\n <style type=\\\"text/css\\\">\\n html {\\n -webkit-text-size-adjust:none;\\n }\\n body {\\n width:100%;\\n margin:0 auto;\\n padding:0;\\n}\\n p {\\n width:280px;\\n line-height: 16px;\\n letter-spacing: 0.5px;\\n }\\n </style>\\n <title>Welcome ... </html>",
"cc": [
{
"email": "George Washington Carver",
"name": "carver@agritech.com"
}
],
"date": 1557950729,
"events": [
{}
],
"files": [
{
"content_disposition": "attachment",
"content_type": "image/jpeg",
"filename": "image.jpeg",
"id": "{image_id}",
"size": 2648890
}
],
"folder": {
"display_name": "string",
"id": "string",
"name": "string"
},
"from": [
{
"name": "Marie Curie",
"email": "marie@radioactivity.com"
}
],
"id": "string",
"object": "message",
"reply_to": [
{
"email": "skwolek@fibers.com",
"name": "Stephanie Kwolek"
}
],
"snippet": "string",
"starred": true,
"subject": "string",
"thread_id": "string",
"to": [
{
"email": "dorothy@spacetech.com",
"name": "Dorothy Vaughan"
}
],
"unread": true,
"labels": [
{
"display_name": "Important",
"id": "{label_id}",
"name": "important"
}
]
}
]

Scopes

The following scopes will get you started using Nylas. Once you're ready to build for production, follow our Create an App Guide to authenticate an account with more scopes.

  • email. modify - Read and modify all messages, threads, file attachments, and read email metadata like headers. Does not include send.
  • email.send - Send messages only. No read or modify privileges on users' emails. Using email.send as the only scope with Gmail accounts may lead to unexpected threading behavior.
  • calendar - Read and modify calendars and events.
  • room_resources.read_only - Read available room resources for an account. Room resources for Office 365 are Admin Consent Required permission.
  • contacts - Read and modify contacts.

iCloud

  1. You'll need to generate an app-specific password.
  2. When you're asked for a password, use the app-specific you generated.
  3. Look for a notification that has the access_token for your new account.
  4. Copy this token and store it somewhere safe; you will need it to make your first requests to the Nylas API.

Ready to build for production?

Take a look at our Create an App Guide.