Sign in
Manage Grants

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.

get/v3/grants/{grantId}

Path parameters

grantIdstring required
Example:5967ca40-a2d8-4ee0-a0e0-6f18ace39a90

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.

Response

Returns Grant object

request_idstring

ID of the request

Example response

{
  "request_id": "5967ca40-a2d8-4ee0-a0e0-6f18ace39a90",
  "data": {
    "account_id": "df0yq6c9okc6t9j4ejd5nyrt7",
    "created_at": 1617817109,
    "email": "nyla@example.com",
    "grant_status": "valid",
    "id": "e19f8e1a-eb1c-41c0-b6a6-d2e59daf7f47",
    "ip": "1.1.1.1",
    "name": "Nyla",
    "provider": "microsoft",
    "provider_user_id": "b16f171c-6640-4edd-a598-e507b546d841",
    "scope": [
      "Mail.Read",
      "User.Read",
      "offline_access"
    ],
    "email_aliases": [
      "email_alias1@example.com",
      "email_alias2@example.com"
    ],
    "state": "my-state",
    "updated_at": 1617817109,
    "workspace_id": "abf6ff99-05ad-4c0a-aaf8-400aacf2470a",
    "credential_id": "c123f8e1a-eb1c-41c0-b6a6-d2e59daf7f47"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.