Nylas

Nylas App migration API

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) Make sure you use the correct region! 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.

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/migration-tools/import-v2-app Import v2 app settings into the linked v3 app · Import v2 app settings to linked v3 app #
Ask an LLM
“Can I copy my v2 application's settings into the linked v3 app?”
“What has to happen before I import v2 app settings?”
Tell an agent
Import the v2 app settings into its linked v3 application.
Copy configuration from my linked v2 app into the v3 app.
POST /v3/migration-tools/grants/{account_id}/clone Migrate one v2 account to a v3 grant · Migrate v2 account to v3 grant #
Ask an LLM
“How do I test-migrate a single v2 connected account to v3?”
“Can I create an invalid v3 grant if the account's credentials don't carry over?”
Tell an agent
Migrate v2 account {account} to a v3 grant.
Clone v2 account {account} to v3, allowing invalid grant creation.
POST /v3/migration-tools/snapshot-batch-clone Batch-migrate v2 accounts to v3 grants · Batch clone v2 accounts to v3 grants #
Ask an LLM
“How do I migrate all my remaining v2 accounts to v3 in one job?”
“Can I limit a batch migration to certain providers?”
Tell an agent
Start a batch clone of v2 accounts to v3 grants.
Batch-migrate {limit} v2 accounts to v3, skipping the first {offset}.
GET /v3/migration-tools/jobs Check migration job progress · Get migration jobs #
Ask an LLM
“What's the progress of my running v2-to-v3 migration jobs?”
“Can I list only migration jobs that have completed?”
Tell an agent
Show my migration jobs.
List migration jobs with status {status}.

Documentation

📖
APIReference
https://developer.nylas.com/docs/reference/notifications/
📖
Documentation
https://developer.nylas.com/docs/v3/notifications/
📖
Documentation
https://developer.nylas.com/docs/
📖
APIReference
https://developer.nylas.com/docs/reference/api/
📖
GettingStarted
https://developer.nylas.com/docs/v3/getting-started/
📖
Authentication
https://developer.nylas.com/docs/v3/auth/
📖
RateLimits
https://developer.nylas.com/docs/dev-guide/platform/rate-limits/
📖
APIReference
https://developer.nylas.com/docs/reference/api/application-level-templates/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/nylas/openapi/nylas-app-migration-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/nylas/json-schema/nylas-grant-object-schema.json
📊
JSONSchema
https://artifacts.apis.io/nylas/json-schema/nylas-application-object-schema.json
📊
JSONSchema
https://artifacts.apis.io/nylas/json-schema/nylas-migration-job-schema.json

Other Resources

🔗
ErrorCodes
https://developer.nylas.com/docs/api/errors/
🔗
Pricing
https://www.nylas.com/pricing/
🔗
Signup
https://dashboard-v3.nylas.com/register
🔗
StatusPage
https://status.nylas.com/
🔗
SDKs
https://github.com/nylas/nylas-nodejs
🔗
SDKs
https://github.com/nylas/nylas-python
🔗
SDKs
https://github.com/nylas/nylas-ruby
🔗
SDKs
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-app-migration-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

nylas-app-migration-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Nylas App migration 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 (42 KB total) ---
# Full source: https://artifacts.apis.io/nylas/openapi/nylas-app-migration-api-openapi.yml