Nylas Connectors (Integrations) API

In Nylas, a connector (formerly called an "integration") stores information that allows your Nylas application to connect to a third party services, such as a provider auth application from Google (GCP), Microsoft (Azure), or to an IMAP provider. You must create a connector in your Nylas application for each specific provider before you can create Grants and access user data from that provider. A Nylas connector stores data about how your Nylas application contacts the provider, the default permissions the Nylas application requests, and is generally the starting point for any authentication with that provider. ## Connector contents The connector stores a label provided by the user, the provider name or type (for example, `google`/`microsoft`/`imap`/`virtual_calendar`), an expiry time for the hosted authentication link, and the provider settings. The "provider's settings" come from the provider itself when you create your provider auth application on Google, Azure, or IMAP. For example, a provider's settings might contain the provider auth application's `client_id` and `client_secret`. Nylas stores these values securely and uses them as default credentials when authenticating with that provider. Nylas follows modern security best practices to encode and encrypt these provider settings, to ensure that they can never be obtained by a third party, including Nylas internal employees. ### What are limitations of connectors? Connectors are associated with a single [Nylas application](/docs/reference/api/applications/). You can have only one Nylas connector for each type of provider. For example, your Nylas application can have only one Google connector. If you want to create a grant for a different provider auth application, (for example, on a different GCP project, but you already have a default Google connector), you can create additional credentials for your connector. Each connector can have multiple credentials, where each credential represents a different provider auth application. For more information, see [Using multiple provider applications](/docs/v3/auth/using-multiple-provider-applications/).

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v3/connectors Set up a connector for a provider · Create a connector #
Ask an LLM
“What's the first step to let users authenticate with a new email provider?”
“How do I create a connector so my app can connect to an external service?”
Tell an agent
Create a new connector in my application.
Set up a provider connector for authentication.
GET /v3/connectors List my application's provider connectors · List connectors #
Ask an LLM
“Which email and calendar provider connectors are set up in my app?”
“How do I page through all the connectors in my application?”
Tell an agent
List all connectors in my application.
Show {limit} connectors starting at offset {offset}.
GET /v3/connectors/{provider} Retrieve the connector for a provider · Get connector #
Ask an LLM
“How can I see the settings and scopes of the connector for a given provider?”
“Can I check which credential is active on a provider's connector?”
Tell an agent
Get the {provider} connector.
Show the settings of my connector for {provider}.
PATCH /v3/connectors/{provider} Change a connector's scopes or settings · Update a connector #
Ask an LLM
“Can I change the OAuth scopes requested by a provider connector?”
“How do I switch which credential a connector uses?”
Tell an agent
Set the scopes on the {provider} connector to {scope}.
Make credential {active_credential_id} active on the {provider} connector.
DELETE /v3/connectors/{provider} Delete a provider connector · Delete a connector #
Ask an LLM
“What happens to existing grants if I delete a connector?”
“How do I remove a provider connector and its credentials?”
Tell an agent destructive · confirm first
Delete the {provider} connector.
Remove my connector for {provider} along with its credentials.
POST /v3/providers/detect Detect a user's email provider from an address · Detect provider #
Ask an LLM
“Can I figure out which email provider an address belongs to before authenticating?”
“Is there a rate limit on detecting providers by email?”
Tell an agent
Detect the email provider for {email}.
Find out which provider hosts the mailbox {email}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/nylas:nylas-connectors-integrations-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

nylas-connectors-integrations-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Nylas Connectors (Integrations) API
  version: v3
  summary: The complete Nylas v3 API — Email, Calendar, Contacts, Notetaker, Scheduling, Administration, and Migration.
  description: The Nylas API is designed using the REST ideology to provide simple and predictable URIs to access and modify objects. Requests support standard HTTP methods like `GET`, `PUT`, `POST`, and `DELETE`, and standard status codes. Response bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. You can use the Nylas Postman collection to quickly start using the Nylas APIs. For more information, check out the Nylas Postman collection documentation.
  contact:
    url: https://www.nylas.com/
servers:
- url: https://api.us.nylas.com
  description: U.S.
- url: https://api.eu.nylas.com
  description: E.U.
security:
- ACCESS_TOKEN: []
- NYLAS_API_KEY: []
tags:


# --- truncated at 32 KB (44 KB total) ---
# Full source: https://artifacts.apis.io/nylas/openapi/nylas-connectors-integrations-api-openapi.yml