How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nylas Admin API

Application-level administration: Nylas applications, API keys, custom domains, connectors and connector credentials, workspaces, and the rules, policies and lists that govern them.

Nylas Admin API is one of 13 APIs that Nylas publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Admin. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 62 operations across 33 paths, and defines 25 schemas. It is described by OpenAPI 3.2.0, at version v3.

Requests are made against 2 base URLs: https://api.us.nylas.com, https://api.eu.nylas.com.

62 operations 33 paths 25 schemas 10 DELETE23 GET5 PATCH20 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v3
Base URL
https://api.us.nylas.com
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Nylas Admin API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (NYLAS_ACCESS_TOKEN) (ACCESS_TOKEN). It accepts HTTP bearer tokens (NYLAS_API_KEY) (NYLAS_API_KEY). By default, every request must be authenticated.

  • ACCESS_TOKEN — The Nylas access token for a specific grant. Issued as part of OAuth 2.1 flow token exchange.
  • NYLAS_API_KEY — The Nylas API key provides application-level access to APIs and all grants. You can generate these from the Dashboard. Learn more about [authorizing requests](…

Paths & Operations 62

Across 33 paths, the API surfaces 62 operations — 10 DELETE, 23 GET, 5 PATCH, 20 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Admin 62
GET
/v3/applications
Get application
get_application → 200400401
PATCH
/v3/applications
Update an application
update_application body → 200400401404
GET
/v3/applications/redirect-uris
Get an application's callback URIs
get_all_callback_uris → 200400404
POST
/v3/applications/redirect-uris
Add callback URI to application
add_callback_uri body → 200400401
GET
/v3/applications/redirect-uris/{id}
Return a callback URI
get_application_callback_uri 1 param → 200401404
PATCH
/v3/applications/redirect-uris/{id}
Update a callback URI
update_callback_uri 1 param body → 200400401404
DELETE
/v3/applications/redirect-uris/{id}
Delete a callback URI
delete_callback_uri 1 param → 200401404
GET
/v3/workspaces
Return all workspaces
get-all-workspaces → 200401404
POST
/v3/workspaces
Create a workspace
create-workspace body → 200400401404
GET
/v3/workspaces/{workspace_id}
Return a workspace
get-workspace 1 param → 200401404
PATCH
/v3/workspaces/{workspace_id}
Update a workspace
update-workspace 1 param body → 200400401404
DELETE
/v3/workspaces/{workspace_id}
Delete a workspace
delete-workspace 1 param → 200400401404
POST
/v3/workspaces/auto-group
Automatically group grants into workspace
autogroup-workspace body → 200401404
POST
/v3/workspaces/{workspace_id}/manual-assign
Update workspace assignments
manually-assign-workspace 1 param body → 200401404
POST
/v3/admin/domains
Create domain
create-domain 4 params body → 200400401429
GET
/v3/admin/domains
List domains
list-domains 6 params → 200400401429
GET
/v3/admin/domains/{domain_id}
Get domain
get-domain 5 params → 200400401404429
PUT
/v3/admin/domains/{domain_id}
Update domain
update-domain 5 params body → 200400401404429
DELETE
/v3/admin/domains/{domain_id}
Delete domain
delete-domain 5 params → 200400401404429
POST
/v3/admin/domains/{domain_id}/info
Get domain info
get-domain-info 5 params body → 200400401404429
POST
/v3/admin/domains/{domain_id}/verify
Verify domain
verify-domain 5 params body → 200400401404429
POST
/v3/admin/applications/{application_id}/api-keys
Create API key
create-api-key 5 params body → 200400401429
GET
/v3/admin/applications/{application_id}/api-keys
Get all API keys
get-api-keys 5 params → 200400401429
GET
/v3/admin/applications/{application_id}/api-keys/{api_key_id}
Get API key
get-api-key 6 params → 200400401429
DELETE
/v3/admin/applications/{application_id}/api-keys/{api_key_id}
Delete API key
delete-api-key 6 params → 200400401429
POST
/v3/connectors
Create a connector
create_connector body → 201400401
GET
/v3/connectors
List connectors
get_connector_all 2 params → 200401404
GET
/v3/connectors/{provider}
Get connector
get_connector_by_provider 1 param → 200401404
PATCH
/v3/connectors/{provider}
Update a connector
update_connector_by_provider 1 param body → 200400401404
DELETE
/v3/connectors/{provider}
Delete a connector
delete_connector_by_provider 1 param → 200401404
POST
/v3/providers/detect
Detect provider
detect_provider_by_email 2 params → 200401
POST
/v3/connectors/{provider}/creds
Create a credential
create_credential 1 param body → 201400401
GET
/v3/connectors/{provider}/creds
List credentials
get_credential_all 5 params → 200401404
GET
/v3/connectors/{provider}/creds/{id}
Get credential
get_credential_by_id 2 params → 200400401
PATCH
/v3/connectors/{provider}/creds/{id}
Update a connector credential
patch_credential_by_id 2 params body → 200400401
DELETE
/v3/connectors/{provider}/creds/{id}
Delete credential
delete_credential_by_id 2 params → 200400401
POST
/v3/rules
Create a rule
create-rule body → 201400401429
GET
/v3/rules
List rules
list-rules 2 params → 200400401429
GET
/v3/rules/{rule_id}
Get a rule
get-rule 1 param → 200400401404429
PUT
/v3/rules/{rule_id}
Update a rule
update-rule 1 param body → 200400401404429
DELETE
/v3/rules/{rule_id}
Delete a rule
delete-rule 1 param → 200400401404429
GET
/v3/grants/{grant_id}/rule-evaluations
List rule evaluations
list-rule-evaluations 3 params → 200400401404429
POST
/v3/policies
Create a policy
create-policy body → 200400401429
GET
/v3/policies
List policies
list-policies 2 params → 200400401429
GET
/v3/policies/{policy_id}
Get a policy
get-policy 1 param → 200400401404429
PUT
/v3/policies/{policy_id}
Update a policy
update-policy 1 param body → 200400401404429
DELETE
/v3/policies/{policy_id}
Delete a policy
delete-policy 1 param → 200400401404429
POST
/v3/lists
Create a list
create-list body → 201400401429
GET
/v3/lists
List lists
list-lists 2 params → 200400401429
GET
/v3/lists/{list_id}
Get a list
get-list 1 param → 200400401404429
PUT
/v3/lists/{list_id}
Update a list
update-list 1 param body → 200400401404429
DELETE
/v3/lists/{list_id}
Delete a list
delete-list 1 param → 200400401404429
POST
/v3/lists/{list_id}/items
Add items to a list
add-list-items 1 param body → 200400401404429
GET
/v3/lists/{list_id}/items
List items in a list
list-list-items 3 params → 200400401404429
DELETE
/v3/lists/{list_id}/items
Remove items from a list
remove-list-items 1 param body → 200400401404429
POST
/v3/migration-tools/link-v2v3-apps
Link a v2 app to a v3 app
migration_link_v2v3_apps → 200400401
POST
/v3/migration-tools/import-v2-app
Import v2 app settings to linked v3 app
migration_import_v2_app → 200400401
POST
/v3/migration-tools/grants/{account_id}/clone
Migrate v2 account to v3 grant
migration_clone_single_account 3 params → 200400401
POST
/v3/migration-tools/snapshot-batch-clone
Batch clone v2 accounts to v3 grants
migration_snapshot_batch_clone 2 params body → 200400401
GET
/v3/migration-tools/jobs
Get migration jobs
migration_get_jobs 3 params → 200400401
POST
/v3/migration-tools/translate
Translate v2 Nylas ID into v3 Provider ID
translate_v2id_to_provider_id body → 200400401
GET
/v3/scheduling/should-redirect/{v2_scheduler_slug}
Redirect v2 Scheduling Page
v2-redirect 1 param → 200400401429

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are GrantObject (18 properties), DomainObject (15 properties), RuleObject (12 properties), GrantRuleEvaluationObject (12 properties). Each schema is shown below with its type and property counts.

RuleObject
object
12 properties
400
object
2 properties 2 required
PolicyObject
object
9 properties
iosCallbackwSettings
object
4 properties
MigrationJob
object
11 properties 10 required
200-delete
Delete Succeeded
AutodetectObject
object
4 properties 2 required
webDesktopCallbackNoSettings
object
3 properties
RedirectURIObject
ApplicationObject
object
9 properties
CredentialObject
object
4 properties 4 required
common_response
object
2 properties
WorkspaceObject
object
10 properties
401
object
2 properties 2 required
ConnectorObject
object
5 properties 2 required
AndroidCallbackwSettings
object
4 properties
JsCallbackwSettings
object
4 properties
GrantRuleEvaluationObject
object
An audit record of a single rule-engine evaluation against an inbound message, SMTP envelope, or outbound send for a grant. Rule evaluations are created automa…
12 properties
translate_v2v3_id
object
5 properties 4 required
DomainVerificationResponse
object
6 properties
ListItemObject
object
4 properties
DomainObject
object
15 properties
404
object
2 properties 2 required
GrantObject
object
18 properties 4 required
ListObject
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nylas-admin-api-openapi.yml Raw ↑

Other APIs Nylas publishes across the network.

Nylas Auth API
Nylas Calendars API
Nylas Contacts API
Nylas Drafts API
Nylas Events API
Nylas Grants API
Nylas Messages API
Nylas Scheduling API
Nylas Threads API
Nylas Notifications API
Nylas Notetaker API
Nylas Templates and Workflows API
Where this information came from

This is an independent, third-party profile of Nylas Admin API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.