Nylas

Nylas Connector credentials API

A Nylas connector credential is a special type of record that securely stores information (such as provider settings) that allows you to connect using an administrator account. Nylas securely stores, hashes, and encrypts the connector credential's sensitive data, and the contents vary depending on the authentication provider. Bulk authentication grants use connector credentials to connect or reconnect user accounts to your Nylas application. You can also use them to override a connector's settings to perform administrative tasks. For more information, see the [Bulk authentication grant documentation](/docs/v3/auth/bulk-auth-grants/). Both Google and Microsoft bulk authentication grants can use connector credentials. To override the default values in a provider's connector settings (for example, the `client_secret` and `client_id`), [create a grant using Bring Your Own Authentication](/docs/v3/auth/bring-your-own-authentication/) and provide the connector credential in your request payload, along with the values to override. ## Connector credential limitations Keep the following limitations in mind as you work with connector credentials: - A connector credential _must_ be connected to an existing Nylas connector. - Each connector credential must have a unique name. - When you make a [Create Credential request](/docs/reference/api/connector-credentials/create_credential/), Nylas checks if a connector credential with the same parameters exists. If one _does_ exist, Nylas uses that connector credential instead of creating one.

Documentation GitHub OpenAPI

Operations 5

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/{provider}/creds Add a credential to a provider connector · Create a credential #

Ask an LLM

“How do I manually add a credential record to a connector?”

“Can a connector hold more than one credential?”

Tell an agent

Create a credential on the {provider} connector.

Add a new manual credential record for {provider}.

GET /v3/connectors/{provider}/creds List credentials on a provider connector · List credentials #

Ask an LLM

“Which credentials are stored for a given provider connector?”

“Can I sort a connector's credentials?”

Tell an agent

List credentials for the {provider} connector.

Show {limit} {provider} credentials sorted by {sort_by}.

GET /v3/connectors/{provider}/creds/{id} Retrieve one connector credential · Get credential #

Ask an LLM

“How can I look up a specific credential on a connector?”

“What's stored in a single connector credential record?”

Tell an agent

Get credential {id} on the {provider} connector.

Show {provider} credential {id}.

PATCH /v3/connectors/{provider}/creds/{id} Update a connector credential · Update a connector credential #

Ask an LLM

“How do I rename a credential on a connector?”

“Can I replace the secret data stored in an existing credential?”

Tell an agent

Rename {provider} credential {id} to {name}.

Replace the data of credential {id} on {provider} with {credential_data}.

DELETE /v3/connectors/{provider}/creds/{id} Delete a non-default connector credential · Delete credential #

Ask an LLM

“Can I delete the active credential on a connector?”

“What happens to grants using a credential when it's deleted?”

Tell an agent destructive · confirm first

Delete credential {id} from the {provider} connector.

Remove unused {provider} credential {id}.

Documentation

https://developer.nylas.com/docs/reference/notifications/

https://developer.nylas.com/docs/v3/notifications/

https://developer.nylas.com/docs/

https://developer.nylas.com/docs/reference/api/

https://developer.nylas.com/docs/v3/getting-started/

https://developer.nylas.com/docs/v3/auth/

https://developer.nylas.com/docs/dev-guide/platform/rate-limits/

https://developer.nylas.com/docs/reference/api/application-level-templates/

Specifications

https://artifacts.apis.io/nylas/openapi/nylas-connector-credentials-api-openapi.yml

Schemas & Data

https://artifacts.apis.io/nylas/json-schema/nylas-credential-object-schema.json

Other Resources

https://developer.nylas.com/docs/api/errors/

https://www.nylas.com/pricing/

https://dashboard-v3.nylas.com/register

https://status.nylas.com/

https://github.com/nylas/nylas-nodejs

https://github.com/nylas/nylas-python

https://github.com/nylas/nylas-ruby

https://github.com/nylas/nylas-java

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-connector-credentials-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: Nylas Connector credentials 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 (35 KB total) ---
# Full source: https://artifacts.apis.io/nylas/openapi/nylas-connector-credentials-api-openapi.yml