Nylas

aid: nylas
name: Nylas
description: Nylas connects your application to every email inbox and calendar in the world. The Nylas v3 platform provides
  REST APIs for email, calendar, contacts, scheduling, meeting notetaking, authentication, and administration across Google,
  Microsoft, Exchange, iCloud, Yahoo and any IMAP provider. Official SDKs cover Node.js, Python, Ruby and Kotlin/Java, alongside
  a CLI, a hosted MCP server, and Agent Accounts that provision a Nylas-hosted mailbox and calendar for autonomous agents
  without requiring an OAuth flow.
type: Index
deliveryModel:
  model: saas
  open_source: false
  commercial: true
  callable_host: true
  label: Hosted service · you call their endpoint
  confidence: high
  source:
  - openapi
  - pricing
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  label: Freemium · Self-serve signup
  confidence: medium
  source:
  - plans
  - authentication
  - security
  generated: '2026-09-03'
  method: derived
position: Consuming
access: 3rd-Party
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/nylas.png
tags:
- Calendar
- Communications
- Contacts
- Email
- Messaging
- Scheduling
- A2A
tags_raw:
- Calendar
- Communication
- Contacts
- Email
- Messaging
- Scheduling
- A2A
created: '2025-02-06'
modified: '2026-04-28'
url: https://raw.githubusercontent.com/api-evangelist/nylas/refs/heads/main/apis.yml
specificationVersion: '0.23'
apis:
- aid: nylas:nylas-contacts-api
  name: Nylas Contacts API
  description: Contacts. Read, create, update and delete a grant's contacts and contact groups.
  humanURL: https://developer.nylas.com/docs/reference/api/contacts/
  baseURL: https://api.us.nylas.com
  tags:
  - Contacts
  properties:
  - type: OpenAPI
    url: openapi/nylas-contacts-api-openapi.yml
- aid: nylas:nylas-drafts-api
  name: Nylas Drafts API
  description: Drafts. Compose, update, send and delete drafts, manage attachments, and generate draft bodies and replies
    with Smart Compose.
  humanURL: https://developer.nylas.com/docs/reference/api/drafts/
  baseURL: https://api.us.nylas.com
  tags:
  - Drafts
  properties:
  - type: OpenAPI
    url: openapi/nylas-drafts-api-openapi.yml
- aid: nylas:nylas-events-api
  name: Nylas Events API
  description: Events. Create, update, delete and list calendar events, including recurring events, group events and RSVP
    handling.
  humanURL: https://developer.nylas.com/docs/reference/api/events/
  baseURL: https://api.us.nylas.com
  tags:
  - Event
  tags_raw:
  - Events
  properties:
  - type: OpenAPI
    url: openapi/nylas-events-api-openapi.yml
- aid: nylas:nylas-messages-api
  name: Nylas Messages API
  description: Messages. List, search, read, update and delete email messages. Send immediately, schedule a send and cancel
    a scheduled send, with folders, signatures and attachments alongside.
  humanURL: https://developer.nylas.com/docs/reference/api/messages/
  baseURL: https://api.us.nylas.com
  tags:
  - Message
  tags_raw:
  - Messages
  properties:
  - type: OpenAPI
    url: openapi/nylas-messages-api-openapi.yml
- aid: nylas:nylas-threads-api
  name: Nylas Threads API
  description: Threads. List, search, read and update email threads, and manage thread-level folders and state.
  humanURL: https://developer.nylas.com/docs/reference/api/threads/
  baseURL: https://api.us.nylas.com
  tags:
  - Threads
  properties:
  - type: OpenAPI
    url: openapi/nylas-threads-api-openapi.yml
- aid: nylas:nylas-notetaker-api
  name: Nylas Notetaker API
  description: Meeting notetaker. Send a notetaker to a Google Meet, Microsoft Teams or Zoom call, then retrieve the recording,
    transcript, summary and action items. Available grant-scoped, or standalone with no connected mailbox required.
  humanURL: https://developer.nylas.com/docs/reference/api/notetaker/
  baseURL: https://api.us.nylas.com
  tags:
  - Notetaker
  - Transcription
  - Meetings
  properties:
  - type: OpenAPI
    url: openapi/nylas-notetaker-api-openapi.yml
  - type: APIReference
    url: https://developer.nylas.com/docs/reference/api/notetaker/
  - type: Documentation
    url: https://developer.nylas.com/docs/v3/notetaker/
- aid: nylas:nylas-amazon-sns-notifications-api
  name: Nylas Amazon SNS Notifications API
  description: 'Amazon SNS notification channels allow you to receive Nylas event notifications through Amazon Simple Notification
    Service (SNS) instead of webhooks.


    To use Amazon SNS notifications, you need to set up an SNS topic and an IAM role in your AWS account. The topic ARN must
    start with `arn:aws:sns:`. The IAM role must allow Nylas to assume it via STS `AssumeRoleWithWebIdentity` and must have
    `sns:Publish` permission on the topic. For detailed set up instructions, see the [Amazon SNS notification channel documentation](/docs/v3/notifications/sns-channel/).


    The Amazon SNS notification channels use the same notification [trigger types and schemas](/docs/reference/notifications/)
    as webhook notifications, and require the same [provider scopes](/docs/dev-guide/scopes/).


    Nylas strongly recommends setting `compressed_delivery` to `true` when you create an SNS channel. SNS enforces a 256 KB
    message size limit, and gzip compression is the simplest way to keep large `message.*` notifications inside it. Nylas
    adds a `content_encoding: gzip+base64` message attribute so your subscriber knows which messages to decompress. For setup
    and the decode pattern, see [Reducing payload size with compression](/docs/dev-guide/best-practices/compression/).'
  humanURL: https://developer.nylas.com/docs/reference/api/applications/
  baseURL: https://api.us.nylas.com
  tags:
  - Amazon SNS Notifications
  properties:
  - type: OpenAPI
    url: openapi/nylas-amazon-sns-notifications-api-openapi.yml
  - type: APIReference
    url: https://developer.nylas.com/docs/reference/notifications/
  - type: Documentation
    url: https://developer.nylas.com/docs/v3/notifications/
  - type: Documentation
    url: https://developer.nylas.com/docs/
  - type: APIReference
    url: https://developer.nylas.com/docs/reference/api/
  - type: GettingStarted
    url: https://developer.nylas.com/docs/v3/getting-started/
  - type: Authentication
    url: https://developer.nylas.com/docs/v3/auth/
  - type: RateLimits
    url: https://developer.nylas.com/docs/dev-guide/platform/rate-limits/
  - type: ErrorCodes
    url: https://developer.nylas.com/docs/api/errors/
  - type: Pricing
    url: https://www.nylas.com/pricing/
  - type: Signup
    url: https://dashboard-v3.nylas.com/register
  - type: StatusPage
    url: https://status.nylas.com/
  - type: SDKs
    url: https://github.com/nylas/nylas-nodejs
  - type: SDKs
    url: https://github.com/nylas/nylas-python
  - type: SDKs
    url: https://github.com/nylas/nylas-ruby
  - type: SDKs
    url: https://github.com/nylas/nylas-java
  - type: APIReference
    url: https://developer.nylas.com/docs/reference/api/application-level-templates/
- aid: nylas:nylas-app-migration-api
  name: Nylas App migration API
  description: 'Before you begin, you should already have:


    - Linked your v2 and v3 Nylas organizations. If you''re not sure if your organizations are linked and you have a contract
    with us, [contact Nylas Support](/docs/support/#contact-nylas-support).

    - Created v3 applications to serve as the destinations for your v2 settings and connected account information.

    - [Set up equivalent provider auth apps as needed](/docs/v2/upgrade-to-v3/upgrade/auth/), especially if your users are
    authenticating with Microsoft.

    - [Set up v3 notification infrastructure](/docs/v2/upgrade-to-v3/upgrade/webhooks/). You''ll use this to keep track of
    object that update while you''re migrating your applications.


    You make Migration API requests using the v3 API route, using an API key from the destination v3 application.


    For each application to be migrated:


    1. [Link apps](#post-/v3/migration-tools/link-v2v3-apps)

    2. [Import app settings](#post-/v3/migration-tools/import-v2-app)

    3. [Migrate a test user](#post-/v3/migration-tools/grants/-account_id-/clone) and/or [Start a batch migration](#post-/v3/migration-tools/snapshot-batch-clone)


    <div id="admonition-warning"><strong>Make sure you use the correct region!</strong> In Nylas v3, you mange applications
    for both the U.S. and E.U. regions using the same Dashboard. If you''re migrating a v2 application to a v3 one, make sure
    you create the v3 application in the correct region. </div>'
  humanURL: https://developer.nylas.com/docs/reference/api/applications/
  baseURL: https://api.us.nylas.com
  tags:
  - App migration
  properties:
  - type: OpenAPI
    url: openapi/nylas-app-migration-api-openapi.yml
  - type: APIReference
    url: https://developer.nylas.com/docs/reference/notifications/
  - type: Documentation
    url: https://developer.nylas.com/docs/v3/notifications/
  - type: Documentation
    url: https://developer.nylas.com/docs/
  - type: APIReference
    url: https://developer.nylas.com/docs/reference/api/
  - type: GettingStarted
    url: https://developer.nylas.com/docs/v3/getting-started/
  - type: Authentication
    url: https://developer.nylas.com/docs/v3/auth/
  - type: RateLimits
    url: https://developer.nylas.com/docs/dev-guide/platform/rate-limits/
  - type: ErrorCodes
    url: https://developer.nylas.com/docs/api/errors/
  - type: Pricing
    url: https://www.nylas.com/pricing/
  - type: Signup
    url: https://dashboard-v3.nylas.com/register
  - type: StatusPage
    url: https://status.nylas.com/
  - type: SDKs
    url: https://github.com/nylas/nylas-nodejs
  - type: SDKs
    url: https://github.com/nylas/nylas-python
  - type: SDKs
    url: https://github.com/nylas/nylas-ruby
  - type: SDKs
    url: https://github.com/nylas/nylas-java
  - type: APIReference
    url: https://developer.nylas.com/docs/reference/api/application-level-templates/
- aid: nylas:nylas-application-level-templates-api
  name: Nylas Application-level templates API
  description: 'Application-level templates let you create reusable messages with dynamic content. Each template is linked
    to the Nylas application associated with the API key specified in a [Create Template request](/docs/reference/api/application-level-templates/create-app-level-template/).


    <div id="admonition-info">💡 <b>If you want to create templates for specific grants, use the <a href="/docs/reference/api/grant-level-templates/">grant-level
    templates endpoints</a></b>.</div>


    Nylas supports the following templating engines:


    - [Handlebars](https://handlebarsjs.com/)

    - [mustache }}](https://mustache.github.io/)

    - [Nunjucks](https://mozilla.github.io/nunjucks/)

    - [Twig](https://twig.symfony.com/)


    We recommend you use [mustache }}](https://mustache.github.io/) or [Handlebars](https://handlebarsjs.com/) if you need
    a simple implementation. If you need more advanced formatting, conditions, or layouts, we recommend [Nunjucks](https://mozilla.github.io/nunjucks/)
    or [Twig](https://twig.symfony.com/).'
  humanURL: https://developer.nylas.com/docs/reference/api/applications/
  baseURL: https://api.us.nylas.com
  tags:
  - Application-level templates
  properties:
  - type: OpenAPI
    url: openapi/nylas-application-level-templates-api-openapi.yml
  - type: APIReference
    url: https://developer.nylas.com/docs/reference/notifications/
  - type: Documentation
    url: https://developer.nylas.com/docs/v3/notifications/
  - type: Documentation
    url: https://developer.nylas.com/docs/
  - type: APIReference
    url: https://developer.nylas.com/docs/reference/api/
  - type: GettingStarted
    url: https://developer.nylas.com/docs/v3/getting-started/
  - type: Authentication
    url: https://developer.nylas.com/docs/v3/auth/
  - type: RateLimits
    url: https://developer.nylas.com/docs/dev-guide/platform/rate-limits/
  - type: ErrorCodes
    url: https://developer.nylas.com/docs/api/errors/
  - type: Pricing
    url: https://www.nylas.com/pricing/
  - type: Signup
    url: https://dashboard-v3.nylas.com/register
  - type: StatusPage
    url: https://status.nylas.com/
  - type: SDKs
    url: https://github.com/nylas/nylas-nodejs
  - type: SDKs
    url: https://github.com/nylas/nylas-python
  - type: SDKs
    url: https://github.com/nylas/nylas-ruby
  - type: SDKs
    url: https://github.com/nylas/nylas-java
  - type: APIReference
    url: https://developer.nylas.com/docs/reference/api/application-level-templates/
- aid: nylas:nylas-application-level-workflows-api
  name: Nylas Application-level workflows API
  description: 'Application-level workflows automatically send messages to certain users when a defined event is triggered.
    For example, if you want to send a confirmation message when a user schedules a booking, you can create a workflow that
    listens for [`booking.created` events](/docs/reference/notifications/#booking-created-notifications).


    Each workflow is linked to the Nylas application associated with the API key specified in a [Create Workflow request](/docs/reference/api/application-level-workflows/create-workflow/).


    <div id="admonition-info">💡 <b>If you want to create workflows for specific grants, use the <a href="/docs/reference/api/grant-level-workflows/">grant-level
    workflows endpoints</a></b>.</div>'
  humanURL: https://developer.nylas.com/docs/reference/api/applications/
  baseURL: https://api.us.nylas.com
  tags:
  - Application-level workflows
  properties:
  - type: OpenAPI
    url: openapi/nylas-application-level-workflows-api-openapi.yml
  - type: APIReference
    url: https://developer.nylas.com/docs/reference/notifications/
  - type: Documentation
    url: https://developer.nylas.com/docs/v3/notifications/
  - type: Documentation
    url: https://developer.nylas.com/docs/
  - type: APIReference
    url: https://developer.nylas.com/docs/reference/api/
  - type: GettingStarted
    url: https://developer.nylas.com/docs/v3/getting-started/
  - type: Authentication
    url: https://developer.nylas.com/docs/v3/auth/
  - type: RateLimits
    url: https://developer.nylas.com/docs/dev-guide/platform/rate-limits/
  - type: ErrorCodes
    url: https://developer.nylas.com/docs/api/errors/
  - type: Pricing
    url: https://www.nylas.com/pricing/
  - type: Signup
    url: https://dashboard-v3.nylas.com/register
  - type: StatusPage
    url: https://status.nylas.com/
  - type: SDKs
    url: https://github.com/nylas/nylas-nodejs
  - type: SDKs
    url: https://github.com/nylas/nylas-python
  - type: SDKs
    url: https://github.com/nylas/nylas-ruby
  - type: SDKs
    url: https://github.com/nylas/nylas-java
  - type: APIReference
    url: https://developer.nylas.com/docs/reference/api/application-level-templates/
- aid: nylas:nylas-applications-api
  name: Nylas Applications API
  description: "In the context of the Nylas APIs, an \"application\" is the object record of your Nylas application.\n\n<div\
    \ id=\"admonition-info\">\U0001F50D <b>The term \"application\" can refer to any of three concepts</b>: your Nylas application,\
    \ the project you're building (\"your application\" or \"your app\"), and applications that you use to connect to service\
    \ providers (\"provider auth applications\"). We try to be specific in this documentation to avoid confusion. The API\
    \ endpoints described here are for working with your Nylas application, specifically.</div>\n\nThe Nylas application is\
    \ the central resource for your Nylas implementation. It collects the [connectors](/docs/reference/api/connectors-integrations/)\
    \ that you use to store information about third party services that your application connects to, and stores the [grants](/docs/reference/api/manage-grants/)\
    \ that you create when using connectors.\n\nNylas applications also allow you to define your specific branding, change\
    \ the look and feel of the Nylas Hosted authentication flow, and list your application's callback URIs.\n\n## Application\
    \ callback URIs\n\nYour Nylas application includes a list of allowed callback URIs. These are known URIs that Nylas can\
    \ direct users to after authentication. You need to define at least _one_ callback URI so your users can complete the\
    \ auth flow.\n\nYou must include any callback URIs you plan to use in this list. If an auth payload includes a callback\
    \ URI that isn't on the list, the whole authentication flow fails.\n\n## Application limitations\n\n<div id=\"admonition-warning\"\
    >⚠️ <b>You can create, edit, and delete applications from the Nylas Dashboard</b>. You <i>cannot</i> create, edit, or\
    \ delete them using the Nylas APIs.</div>\n\nKeep the following limitations in mind as you work with Nylas applications:\n\
    \n- Applications are the central resource that stores other Nylas resources. You _must_ create an application before you\
    \ can create any other parts of your Nylas implementation.\n- Applications can be associated with only one project at\
    \ a time. While your project can have more than one Nylas application to provide different authentication experiences,\
    \ you cannot share applications, connectors, or grants between more than one project.\n- Applications cannot be nested,\
    \ and cannot be set up with parent-child relationships.\n- Your application must have _at least one_ callback URI, or\
    \ else it cannot finish the authentication flow, which means it cannot create grants. Nylas requires grants to access\
    \ user data.\n  - In an ideal scenario, your application will have multiple callback URIs defined."
  humanURL: https://developer.nylas.com/docs/reference/api/applications/
  baseURL: https://api.us.nylas.com
  tags:
  - Application
  tags_raw:
  - Applications
  properties:
  - type: OpenAPI
    url: openapi/nylas-applications-api-openapi.yml
  - type: APIReference
    url: https://developer.nylas.com/docs/reference/notifications/
  - type: Documentation
    url: https://developer.nylas.com/docs/v3/notifications/
  - type: Documentation
    url: https://developer.nylas.com/docs/
  - type: APIReference
    url: https://developer.nylas.com/docs/reference/api/
  - type: GettingStarted
    url: https://developer.nylas.com/docs/v3/getting-started/
  - type: Authentication
    url: https://developer.nylas.com/docs/v3/auth/
  - type: RateLimits
    url: https://developer.nylas.com/docs/dev-guide/platform/rate-limits/
  - type: ErrorCodes
    url: https://developer.nylas.com/docs/api/errors/
  - type: Pricing
    url: https://www.nylas.com/pricing/
  - type: Signup
    url: https://dashboard-v3.nylas.com/register
  - type: StatusPage
    url: https://status.nylas.com/
  - type: SDKs
    url: https://github.com/nylas/nylas-nodejs
  - type: SDKs
    url: https://github.com/nylas/nylas-python
  - type: SDKs
    url: https://github.com/nylas/nylas-ruby
  - type: SDKs
    url: https://github.com/nylas/nylas-java
  - type: APIReference
    url: https://developer.nylas.com/docs/reference/api/application-level-templates/
- aid: nylas:nylas-attachments-api
  name: Nylas Attachments API
  description: 'You can use the `attachments` schema in a [Send Message request](/docs/reference/api/messages/send-message/)
    to send attachments, regardless of the email provider. You use the [Drafts](/docs/reference/api/drafts/) endpoints to
    add and modify files attached to drafts. The Attachments endpoints let you download or get the metadata for existing attachments.
    For more information, see [Working with email attachments](/docs/v3/email/attachments/).


    If you''re using draft support, the draft (including the attachment) is stored on the provider. If you''re not using draft
    support, Nylas stores the attachment.


    You can make a [Get Attachment Metadata request](/docs/reference/api/attachments/get-attachments-id/) to retrieve a single
    attachment''s metadata using its ID.


    ## What counts as an attachment?


    In Nylas, an attachment is any file included either inline as part of a message, or attached to a message as a file.


    Some major email providers, such as Google and Microsoft, have their own cloud storage ("drive") services. These files
    usually appear as links in the message body instead of attachments on the Message object. Google Drive lets users attach
    files either as a link, or a file. Microsoft One Drive attachments always appear as links in the message body.


    ## Attachment size discrepancies


    When Nylas returns information about an attachment, its listed size might be different from the actual size of the file.
    This is because of provider encryption methods, message headers, and rounding on the provider side. For example, if you
    receive a 3480-byte attachment in an email, Nylas might list it as 3680 bytes.


    ## Attachments scopes


    The table below lists the Attachments endpoints and which scopes they require. The table shortens the full scope URI for
    space reasons, so add the prefix for the provider when requesting scopes.


    The ☑️ in each column indicates the most restrictive scope you can request for each provider and still use that API. More
    permissive scopes appear under the minimum option. If you''re already using one of the permissive scopes, you don''t need
    to add the more restrictive scope.


    | Endpoint                                                                                   | Google Scopes</br>`https://www.googleapis.com/auth/...`
    | Microsoft Scopes</br>`https://graph.microsoft.com/...`                                 |

    | :----------------------------------------------------------------------------------------- | :------------------------------------------------------
    | :------------------------------------------------------------------------------------- |

    | **GET** `/attachments/<ATTACHMENT_ID>`</br>**GET** `/attachments/<ATTACHMENT_ID>/download` | `/gmail.readonly` ☑️</br>`/gmail.modify`                |
    `Mail.Read` ☑️</br>`Mail.ReadWrite`</br>`Mail.ReadWrite.Shared`</br>`Mail.Read.Shared` |


    For more information about scopes, see [Using scopes to request user data](/docs/dev-guide/scopes/).


    ## Query IMAP server directly


    Set the `query_imap` query parameter to `true` in your [Get Attachment Metadata](/docs/reference/api/attachments/get-attachments-id/)
    or [Download Attachment](/docs/reference/api/attachments/get-attachments-id-download/) requests to query the IMAP server
    directly instead of the Nylas database. This lets you get the most up-to-date information from the IMAP server, or data
    older than the default three-month retention time.


    Keep in mind that most IMAP servers are slow and have low [rate limits](/docs/dev-guide/platform/rate-limits/). Nylas
    might take more time to return responses compared to requests that don''t use the `query_imap` query parameter. If an
    account has many folders, or you''re querying for a large attachment, your request can take even longer.


    ## Microsoft attachment size discrepancies


    If you''re working with Microsoft grants, you might notice a small difference between the attachment size in Nylas'' response
    and the actual size of the downloaded file. This is because Nylas'' attachment size calculation includes any MIME encoding
    headers. Nylas returns this value to be consistent with the provider, and so that it doesn''t have to pre-process all
    attachment content.


    When working with attachments on Microsoft grants, we recommend you...


    - Treat the metadata `size` field as an estimate for UI display purposes.

    - Always use the actual downloaded file for storage calculations and file operations.

    - Implement flexible buffer handling when the exact byte count of a file matters to your project.

    - Test your Nylas integration with a number of different attachment types and sizes.'
  humanURL: https://developer.nylas.com/docs/reference/api/applications/
  baseURL: https://api.us.nylas.com
  tags:
  - Attachments
  properties:
  - type: OpenAPI
    url: openapi/nylas-attachments-api-openapi.yml
  - type: APIReference
    url: https://developer.nylas.com/docs/reference/notifications/
  - type: Documentation
    url: https://developer.nylas.com/docs/v3/notifications/
  - type: Documentation
    url: https://developer.nylas.com/docs/
  - type: APIReference
    url: https://developer.nylas.com/docs/reference/api/
  - type: GettingStarted
    url: https://developer.nylas.com/docs/v3/getting-started/
  - type: Authentication
    url: https://developer.nylas.com/docs/v3/auth/
  - type: RateLimits
    url: https://developer.nylas.com/docs/dev-guide/platform/rate-limits/
  - type: ErrorCodes
    url: https://developer.nylas.com/docs/api/errors/
  - type: Pricing
    url: https://www.nylas.com/pricing/
  - type: Signup
    url: https://dashboard-v3.nylas.com/register
  - type: StatusPage
    url: https://status.nylas.com/
  - type: SDKs
    url: https://github.com/nylas/nylas-nodejs
  - type: SDKs
    url: https://github.com/nylas/nylas-python
  - type: SDKs
    url: https://github.com/nylas/nylas-ruby
  - type: SDKs
    url: https://github.com/nylas/nylas-java
  - type: APIReference
    url: https://developer.nylas.com/docs/reference/api/application-level-templates/
- aid: nylas:nylas-authentication-apis-api
  name: Nylas Authentication APIs API
  description: "Nylas provides two ways to handle authentication:\n\n- **Bring Your Own (BYO) Authentication**, which uses\
    \ the [`/v3/connect/custom` endpoint](/docs/reference/api/manage-grants/byo_auth/). In BYO Authentication, you already\
    \ have refresh tokens for your users, and you just need to create grants for them in Nylas. This endpoint is also used\
    \ for [virtual calendars](/docs/v3/calendar/virtual-calendars/), [IMAP auth](/docs/v3/auth/imap/), and [bulk auth grants](/docs/v3/auth/bulk-auth-grants/).\n\
    - **Hosted OAuth**, where the user completes an OAuth process on the provider, and the provider returns an access token.\
    \ Depending on your needs, you can use either the user's access token or a Nylas API key to authorize requests after you\
    \ complete the OAuth flow. See the [Authentication documentation](/docs/v3/auth/) for more information.\n\n## Hosted authentication\
    \ with OAuth\n\nOAuth is the modern industry-standard protocol for authorization, and is used by major technology companies\
    \ like Google, Apple, Microsoft, and others. Nylas supports authentication using the [OAuth 2.0 protocol](https://oauth.net/2/)\
    \ and an additional option to use PKCE for extra security. [PKCE is an extension of the OAuth 2.0 protocol](https://oauth.net/2/pkce/)\
    \ that prevents authorization code interception attacks, and makes OAuth 2.0 more secure on mobile devices and client-side\
    \ applications.\n\nDuring the OAuth 2.0 authentication flow, the user provides the account that they want to authenticate\
    \ to Nylas, and they're prompted to allow your application's \"scopes\" (for example, `https://www.googleapis.com/auth/gmail.readonly`\
    \ or `https://www.googleapis.com/auth/userinfo.profile`). Nylas always returns the fully-qualified Google scopes when\
    \ you make an Authentication request that references a Google grant. For grants authenticated with other providers, Nylas\
    \ returns the truncated scopes.\n\n### Using Hosted OAuth\n\nTo use Hosted OAuth you first need to create a Nylas application\
    \ in the Nylas Dashboard, then create a [connector](/docs/reference/api/connectors-integrations/) in that application\
    \ for each authentication provider. This allows Nylas to get and store each provider's settings, and configure a set of\
    \ default scopes to apply.\n\nNylas can detect which provider a user is authenticating with and redirect them to the correct\
    \ provider's authentication system.\n\nIf the user decides to choose different provider settings for an OAuth 2.0 authorization\
    \ protocol, Nylas allows them to override the default provider connector's settings.\n\nA successful OAuth authorization\
    \ results in a [grant](/docs/reference/api/manage-grants/) with the scopes that the user allowed.\n\nSee [Create grants\
    \ with OAuth 2.0 and PKCE](/docs/v3/auth/hosted-oauth-accesstoken/#create-grants-with-oauth-2.0-and-pkce) for more information.\n\
    \n### Adding the \"Sign in with Google\" button\n\nYour Google provider auth app must have a \"Sign in with Google\" button\
    \ that meets [Google's branding guidelines](https://developers.google.com/identity/branding-guidelines). This applies\
    \ to the OAuth flow for both personal Gmail (`@gmail.com`) and Workspace email addresses.\n\nFor Hosted authentication,\
    \ Nylas recommends you do one of the following:\n\n- Configure the OAuth login prompt by setting the `prompt` parameter\
    \ with `select_provider` or `detect,select_provider`. For more information, see [Configure the OAuth login prompt](/docs/v3/auth/customize-login-prompt/).\n\
    \n  <div id=\"admonition-warning\">⚠️ If you add a <code>login_hint</code> that is a personal Gmail or\nWorkspace email\
    \ address, and you don't configure a <code>prompt</code> during the Hosted auth flow, the user is directed immediately\
    \ to the Google OAuth page without clicking the \"Sign in with Google\" button. This can result in delays or failure in\
    \ verification.\n  </div>\n\n- Use the pre-approved \"Sign in with Google\" button along with the \"Connect your account\"\
    \ button (or other provider login buttons) in your application. For more information, see Google's official [Sign in with\
    \ Google branding guidelines](https://developers.google.com/identity/branding-guidelines).\n\nFor Bring Your Own Authentication,\
    \ use the pre-approved \"Sign in with Google\" button along with the \"Connect your account\" button (or other provider\
    \ login buttons) in your application.\n\nLearn more about [Google verification and security assessment](/docs/provider-guides/google/google-verification-security-assessment-guide/)."
  humanURL: https://developer.nylas.com/docs/reference/api/applications/
  baseURL: https://api.us.nylas.com
  tags:
  - Authentication APIs
  properties:
  - type: OpenAPI
    url: openapi/nylas-authentication-apis-api-openapi.yml
  - type: APIReference
    url: https://developer.nylas.com/docs/reference/notifications/
  - type: Documentation
    url: https://developer.nylas.com/docs/v3/notifications/
  - type: Documentation
    url: https://developer.nylas.com/docs/
  - type: APIReference
    url: https://developer.nylas.com/docs/reference/api/
  - type: GettingStarted
    url: https://developer.nylas.com/docs/v3/getting-started/
  - type: Authentication
    url: https://developer.nylas.com/docs/v3/auth/
  - type: RateLimits
    url: https://developer.nylas.com/docs/dev-guide/platform/rate-limits/
  - type: ErrorCodes
    url: https://developer.nylas.com/docs/api/errors/
  - type: Pricing
    url: https://www.nylas.com/pricing/
  - type: Signup
    url: https://dashboard-v3.nylas.com/register
  - type: StatusPage
    url: https://status.nylas.com/
  - type: SDKs
    url: https://github.com/nylas/nylas-nodejs
  - type: SDKs
    url: https://github.com/nylas/nylas-python
  - type: SDKs
    url: https://github.com/nylas/nylas-ruby
  - type: SDKs
    url: https://github.com/nylas/nylas-java
  - type: APIReference
    url: https://developer.nylas.com/docs/reference/api/application-level-templates/


# --- truncated at 32 KB (134 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/nylas/refs/heads/main/apis.yml