Method: users.settings.delegates.list

Lists the delegates for the specified account.

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

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.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response for the delegates.list method.

JSON representation
{
  "delegates": [
    {
      object (Delegate)
    }
  ]
}
Fields
delegates[]

object (Delegate)

List of the user's delegates (with any verification status). If an account doesn't have delegates, this field doesn't appear.

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 OAuth 2.0 Overview.