Skip to content

Google: 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

Google gmailUsersSettingsDelegates.gmailUsersSettingsDelegatesGet: arguments, response, policy and SDK examples.

← gmail_users_settings_delegates operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation google.gmail_users_settings_delegates_get

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

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"]["gmailUsersSettingsDelegatesGet"]>[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.gmailUsersSettingsDelegatesGet(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_get(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.delegateEmailstringRequired within parentThe email address of the user whose delegate relationship is to be retrieved.
path.userIdstringRequired within parentUser’s email address. The special value “me” can be used to indicate the authenticated user.
Default: me
queryobjectOptionalAdditional keys: not allowed
query.fieldsstringOptionalSelector specifying which fields to include in a partial response.
query.prettyPrintbooleanOptionalReturns response with indentations and line breaks.
Default: true
query.quotaUserstringOptionalAvailable 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 media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand 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

SDK function policy ID: google.gmail_users_settings_delegates_get. Catalog operation: gmail.users.settings.delegates.get. 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

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.