Method: users.settings.delegates.list
Stay organized with collections
Save and categorize content based on your preferences.
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
Response for the delegates.list method.
If successful, the response body contains data with the following structure:
| 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 Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-24 UTC.
[null,null,["Last updated 2025-03-24 UTC."],[],[],null,["# Method: users.settings.delegates.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListDelegatesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n\nLists the delegates for the specified account.\n\nThis method is only available to service account clients that have been delegated domain-wide authority.\n\n### HTTP request\n\n`GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/delegates`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-------------------------------------------------------------------------------------------------------|\n| `userId` | `string` User's email address. The special value \"me\" can be used to indicate the authenticated user. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse for the delegates.list method.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------|\n| ``` { \"delegates\": [ { object (/workspace/gmail/api/reference/rest/v1/users.settings.delegates#Delegate) } ] } ``` |\n\n| Fields ||\n|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `delegates[]` | `object (`[Delegate](/workspace/gmail/api/reference/rest/v1/users.settings.delegates#Delegate)`)` List of the user's delegates (with any verification status). If an account doesn't have delegates, this field doesn't appear. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/gmail.settings.basic`\n- `\n https://mail.google.com/`\n- `\n https://www.googleapis.com/auth/gmail.modify`\n- `\n https://www.googleapis.com/auth/gmail.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
