Method: users.settings.delegates.get

Gets the specified delegate.

Note that a delegate user must be referred to by their primary email address, and not an email alias.

This method is only available to service account clients that have been delegated domain-wide authority.

HTTP request

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/delegates/{delegateEmail}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
userId

string

User's email address. The special value "me" can be used to indicate the authenticated user.
delegateEmail

string

The email address of the user whose delegate relationship is to be retrieved.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Delegate.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/gmail.settings.basic
  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly

For more information, see the Authorization guide.