Get current grant

request_idstring

ID of the request

Example: "5967ca40-a2d8-4ee0-a0e0-6f18ace39a90"

dataobject

account_idstring

The v2 Nylas account ID. This field appears only if the grant was created by migrating a v2 connected account.

Example: "df0yq6c9okc6t9j4ejd5nyrt7"

blockedboolean

When true, indicates that the grant is blocked from accessing the Nylas APIs.

Example: false

created_at*integer

When the grant was created, in seconds using the Unix timestamp format.

Example: 1617817109

emailstring

The email address associated with the grant. If the provider supports id_token and exposes the user's email address, Nylas automatically extracts this value.

Example: "[email protected]"

grant_statusstring

Specifies whether the grant is valid or the user needs to re-authenticate.

invalidvalid

Example: "valid"

id*string

A unique identifier for the grant.

Example: "e19f8e1a-eb1c-41c0-b6a6-d2e59daf7f47"

ipstring

The user's client IP address. Mostly useful for Hosted OAuth.

Example: "1.1.1.1"

namestring

The user's display name.

Example: "Nyla"

provider*string

The provider that the user authenticated with.

ewsgoogleicloudimapmicrosoftvirtual-calendaryahoozoomnylas

Example: "microsoft"

provider_user_idstring

The user's provider ID. This field might be changed at any time by the provider.

Example: "b16f171c-6640-4edd-a598-e507b546d841"

scope*array<string>

An array of granular scopes associated with the grant. If none are specified, Nylas uses the default scopes from the connector.

Example: ["Mail.Read","User.Read","offline_access"]

settingsobject

A list of settings associated with the grant. The contents of this object might differ between grants or depending on the provider.

email_aliasesarray<string>

An array of found email aliases for this grant. Only returned if special query parameter expose_aliases for Get Grant is used and set to true. Applicable only for Google and Microsoft grants. For Microsoft, aliases require a Microsoft 365 / Exchange Online mailbox. Free Outlook.com (consumer) accounts have no aliases to expose, so this field is omitted from the response even when expose_aliases=true.

Example: ["[email protected]","[email protected]"]

statestring

The initial state that was set as part of the authentication process. Nylas passes this value back to your project without modifying it. You can use this field for verification, or to track information about the user.

Example: "my-state"

updated_atinteger

When the user last authenticated their grant, in seconds using the Unix timestamp format. Initially, this value is the same as created_at.

Example: 1617817109

user_agentstring

The user's client or browser information. Mostly useful for Hosted OAuth.

workspace_idstring

The ID of the workspace the grant belongs to, if any. Nylas always returns this field for Agent Accounts. For grants from other providers, Nylas omits it when the grant is in the application's default workspace and returns it when the grant is in any other workspace.

Example: "abf6ff99-05ad-4c0a-aaf8-400aacf2470a"

credential_idstring

The ID of the Credential the grant is associated with. Grant will use this Credential for provider communication.

Example: "c123f8e1a-eb1c-41c0-b6a6-d2e59daf7f47"

Responses