/gmail/v1/users/{userId}/settings/delegates/{delegateEmail}

GET

users

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://gmail.googleapis.com//gmail/v1/users//settings/delegates/'

Response Example

{
    "delegateEmail": "string",
    "verificationStatus": "verificationStatusUnspecified"
}

Request

Path Params

userId

string

required

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

delegateEmail

string

required

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

Responses

🟢200Successful response

application/json

Body

Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account. See "Set up mail delegation" for more information about delegates.

delegateEmail

string

optional

The email address of the delegate.

verificationStatus

enum<string>

optional

Indicates whether this address has been verified and can act as a delegate for the account. Read-only.

Allowed values:

verificationStatusUnspecifiedacceptedpendingrejectedexpired

/gmail/v1/users/{userId}/settings/delegates/{delegateEmail}

/gmail/v1/users/{userId}/settings/filters