Skip to content
Skip to main content
GET
https://api.us.nylas.com/v3/grants/{grantId}

Get a grant

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 grants for best practices on detection and recovery.

NYLAS API KEY

Parameters

Path parameters

grantId*string

Query parameters

expose_aliasesboolean

If set to true, the response will include an array of email aliases associated with the grant. Applicable only for Google and Microsoft grants. Not set by default. For Microsoft, aliases are only available for Microsoft 365 / Exchange Online mailboxes. Free Outlook.com (consumer) accounts have no aliases to expose, so the email_aliases field is omitted from the response entirely. Email aliases are only returned for the called API, not stored in the grant object permanently.

Default: false

Responses

request_idstring

ID of the request

Example: "5967ca40-a2d8-4ee0-a0e0-6f18ace39a90"
dataobject
GEThttps://api.us.nylas.com/v3/grants/{grantId}?expose_aliases=false

Find your API key in the Nylas Dashboard under API Keys in your application settings.

grantIdrequiredstring
expose_aliasesboolean

If set to true, the response will include an array of email aliases associated with the grant. Applicable only for Google and Microsoft grants. Not set by default. For Microsoft, aliases are only available for Microsoft 365 / Exchange Online mailboxes. Free Outlook.com (consumer) accounts have no aliases to expose, so the email_aliases field is omitted from the response entirely. Email aliases are only returned for the called API, not stored in the grant object permanently.