Google: Lists the delegates for the specified account For more information, see Manage delegates (https: developers google com workspace gmail api guides delegate settings) This method is only available to service account clients that have been delegated domain-wide authority

← Gmail users settings delegates operations · Get started

Operation google.gmail_users_settings_delegates_list

Provider route: GET /gmail/v1/users/{userId}/settings/delegates. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/google with npm, or alter-sdk-google with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GoogleIntegration } from "@alter-ai/google";

async function execute(input: Parameters<GoogleIntegration["gmailUsersSettingsDelegates"]["gmailUsersSettingsDelegatesList"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GoogleIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.gmailUsersSettingsDelegates.gmailUsersSettingsDelegatesList(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_google import GoogleIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GoogleIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.gmail_users_settings_delegates.gmail_users_settings_delegates_list(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.userId	string	Required within parent	User’s email address. The special value “me” can be used to indicate the authenticated user. Default: me
query	object	Optional	Additional keys: not allowed
query.fields	string	Optional	Selector specifying which fields to include in a partial response.
query.prettyPrint	boolean	Optional	Returns response with indentations and line breaks. Default: true
query.quotaUser	string	Optional	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Lists the delegates for the specified account For more information, see Manage delegates (https: developers google com workspace gmail api guides delegate settings) This method is only available to service account clients that have been delegated domain-wide authority — response body

Referenced models: Lists the delegates for the specified account For more information, see Manage delegates (https: developers google com workspace gmail api guides delegate settings) This method is only available to service account clients that have been delegated domain-wide authority — response body

Schemas

Lists the delegates for the specified account For more information, see Manage delegates (https: developers google com workspace gmail api guides delegate settings) This method is only available to service account clients that have been delegated domain-wide authority — response body

Field	Type	Presence	Description and constraints
$	object	Root	Response for the ListDelegates method.
delegates	array	Optional	List of the user's delegates (with any verification status). If an account doesn't have delegates, this field doesn't appear.
delegates[]	Model	Each item	Expand Gets the specified delegate For more information, see Manage delegates (https: developers google com workspace gmail api guides delegate settings) 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 — response body

Referenced models: Gets the specified delegate For more information, see Manage delegates (https: developers google com workspace gmail api guides delegate settings) 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 — response body

Gets the specified delegate For more information, see Manage delegates (https: developers google com workspace gmail api guides delegate settings) 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 — response body

Field	Type	Presence	Description and constraints
$	object	Root	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	string	Optional	Indicates whether this address has been verified and can act as a delegate for the account. Read-only. Known values: verificationStatusUnspecified, accepted, pending, rejected, expired

Policy, approvals and errors

SDK function policy ID: google.gmail_users_settings_delegates_list. Catalog operation: gmail.users.settings.delegates.list. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["https://mail.google.com/", "https://www.googleapis.com/auth/gmail.modify", "https://www.googleapis.com/auth/gmail.readonly", "https://www.googleapis.com/auth/gmail.settings.basic"]

Official provider source