Nylas Cloud
The Nylas API integrates email, calendar, contacts, and meetings into your platform. One integration connects your app with 100% of email services (IMAP, Exchange/ActiveSync, Outlook, Gmail, Yahoo, etc.), creating one unified source of data for teams to reference. Send personalized email drip campaigns at scale while reaching your customer's inbox with nearly 100% email deliverability. Track…
58 subscribers
100 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
Nylas Cloud endpoints
| Method | Endpoint | Description |
|---|---|---|
| Authentication APIs | ||
| GET |
get_oauth2_flow /v3/connect/auth |
The initial OAuth 2.0 authorization request. Use this endpoint with the required query parameters to start the OAuth 2.0 process. The query parameters pass details to the Nylas… |
| Manage Grants | ||
| GET |
get_grant_by_access_token /v3/grants/me |
Gets a grant using current access token |
| GET |
get_grant_by_id /v3/grants/{grantId} |
Gets a grant with the provided ID. If the grant's `grant_status` is `invalid`, the grant has expired and needs to be re-authenticated. See [Handling expired… |
| PATCH |
patch_grant_by_id /v3/grants/{grantId} |
Updates the specified grant's stored settings or scope metadata. **Common use cases:** - **Rotate a refresh token** — If you obtain a new `refresh_token` from a provider (for… |
| Connectors (Integrations) | ||
| DELETE |
delete_connector_by_provider /v3/connectors/{provider} |
Delete the existing connector for the provider you specify. |
| Connector credentials | ||
| POST |
create_credential /v3/connectors/{provider}/creds |
Manually create a credential record. |
| GET |
get_credential_all /v3/connectors/{provider}/creds |
List credentials for the specified provider. |
| DELETE |
delete_credential_by_id /v3/connectors/{provider}/creds/{id} |
Delete a credential with the specified ID. |
| PATCH |
patch_credential_by_id /v3/connectors/{provider}/creds/{id} |
Updates the specified connector credential. When you make a `PATCH` request, Nylas replaces all data in the nested object with the information included in your request. For more… |
| GET |
get_credential_by_id /v3/connectors/{provider}/creds/{id} |
Return a credential with the specified ID. |
| Applications | ||
| DELETE |
delete_callback_uri /v3/applications/redirect-uris/{id} |
Deletes the specified callback URI. |
| GET |
get_application /v3/applications |
Gets the application object |
| GET |
get_application_callback_uri /v3/applications/redirect-uris/{id} |
Returns the specified callback URI. |
| PATCH |
update_callback_uri /v3/applications/redirect-uris/{id} |
Updates the specified callback URI. If you don't define the `platform`, Nylas doesn't modify the existing settings. When you make a `PATCH` request, Nylas replaces all data in… |
| GET |
get_all_callback_uris /v3/applications/redirect-uris |
Returns a list of callback URIs for the specified Nylas application. |
| Workspaces | ||
| GET |
get-all-workspaces /v3/workspaces |
Returns all workspaces in your Nylas application. The application queried is determined based on the API key you use to authorize your request. |
| POST |
create-workspace /v3/workspaces |
Creates a workspace. |
| DELETE |
delete-workspace /v3/workspaces/{workspace_id} |
Deletes the specified workspace. |
| POST |
manually-assign-workspace /v3/workspaces/{workspace_id}/manual-assign |
Manually assigns or removes specified grants to or from a specific workspace. You must specify at least one grant ID in either `assign_grants` or `remove_grants`. You can include… |
| GET |
get-workspace /v3/workspaces/{workspace_id} |
Returns the specified workspace. |
| POST |
autogroup-workspace /v3/workspaces/auto-group |
Configures automatic grouping settings for new or existing workspaces, depending on the filters set. If you don't set any filters, Nylas considers all grants. |
| Manage API keys | ||
| GET |
get-api-keys /v3/admin/applications/{application_id}/api-keys |
⚠️ Before you can use the Manage API Keys endpoints, you need to create a Nylas Service Account. Returns a list of API keys associated with the specified Nylas application. |
| GET |
get-api-key /v3/admin/applications/{application_id}/api-keys/{api_key_id} |
⚠️ Before you can use the Manage API Keys endpoints, you need to create a Nylas Service Account. Returns the specified API key. |
| DELETE |
delete-api-key /v3/admin/applications/{application_id}/api-keys/{api_key_id} |
⚠️ Before you can use the Manage API Keys endpoints, you need to create a Nylas Service Account. Deletes the specified API key. |
| POST |
create-api-key /v3/admin/applications/{application_id}/api-keys |
⚠️ Before you can use the Manage API Keys endpoints, you need to create a Nylas Service Account. Creates an API key for the specified Nylas application. |
| Manage Domains | ||
| DELETE |
delete-domain /v3/admin/domains/{domain_id} |
⚠️ Before you can use the Manage Domains endpoints, you need a Nylas Service Account. Deletes the specified domain. This action is irreversible. |
| POST |
create-domain /v3/admin/domains |
⚠️ Before you can use the Manage Domains endpoints, you need a Nylas Service Account. Registers a new email domain for your organization. After creating a domain, you must… |
| Policies | ||
| DELETE |
delete-policy /v3/policies/{policy_id} |
Deletes the specified policy. This action is irreversible. |
| GET |
get-policy /v3/policies/{policy_id} |
Returns the specified policy. |
| GET |
list-policies /v3/policies |
Returns a list of all policies for your application. |
| POST |
create-policy /v3/policies |
Creates a policy for your application. Policies define message limits, spam detection settings, options, and linked rules for Nylas Agent Accounts. The `application_id` and… |
| PUT |
update-policy /v3/policies/{policy_id} |
Updates the specified policy. All fields are optional — only provided fields are updated. The same plan-limit, spam sensitivity, and retention-period validation applies as on… |
| Rules | ||
| GET |
list-rules /v3/rules |
Returns a list of all rules for your application. |
| PUT |
update-rule /v3/rules/{rule_id} |
Updates the specified rule. All fields are optional — only provided fields are updated. The same validation rules apply as on create. |
| Lists | ||
| GET |
list-lists /v3/lists |
Returns all lists for your application. |
| GET |
get-list /v3/lists/{list_id} |
Returns the specified list. |
| DELETE |
delete-list /v3/lists/{list_id} |
Deletes the specified list. This action is irreversible and cascades to all items in the list. Rules that reference the list through an `in_list` condition no longer match its… |
| PUT |
update-list /v3/lists/{list_id} |
Updates the specified list. Only `name` and `description` can be updated. The list `type` is immutable after creation. |
| GET |
list-list-items /v3/lists/{list_id}/items |
Returns the items in the specified list. |
| POST |
create-list /v3/lists |
Creates a list for your application. Lists are typed collections of values (domains, TLDs, or email addresses) that can be referenced by rules using the `in_list` condition… |
| Webhook Notifications | ||
| PUT |
put-webhook-by-id /v3/webhooks/{id} |
Update the values in a specific webhook destination. ### Limitations - You only need to specify fields that need to change when you make a request to this endpoint. Empty fields… |
| DELETE |
delete-webhook-by-id /v3/webhooks/{id} |
Delete a webhook destination record. |
| GET |
get-webhook-destinations-application /v3/webhooks |
Get a list of all webhook destinations for an application id. |
| GET |
get-webhook-by-id /v3/webhooks/{id} |
Get the webhook destinations for an application ID by webhook ID |
| Pub/Sub Notifications | ||
| GET |
get-pubsub-by-id /v3/channels/pubsub/{id} |
Get a specific Pub/Sub channel from a specific Nylas application. |
| GET |
get-pubsub-channels /v3/channels/pubsub |
Get the Pub/Sub channels for an application. |
| Amazon SNS Notifications | ||
| GET |
get-sns-channels /v3/channels/sns |
Get the Amazon SNS notification channels for an application. |
| PUT |
put-sns-by-id /v3/channels/sns/{id} |
Updates the specified Amazon SNS notification channel. When you make a `PUT` request, Nylas replaces all data in the nested object with the information included in your request.… |
| DELETE |
delete-sns-by-id /v3/channels/sns/{id} |
Delete a specific Amazon SNS notification channel from a specific Nylas application. |
| Messages | ||
| GET |
get-messages-id /v3/grants/{grant_id}/messages/{message_id} |
Returns the specified message. |
+ 50 more endpoints on the provider's documentation.
Nylas Cloud pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
