Google: Gets vacation responder settings For more information, see Manage vacation settings with the Gmail API (https: developers google com workspace gmail api guides vacation settings)

← Gmail users settings operations · Get started

Operation google.gmail_users_settings_getvacation

Provider route: GET /gmail/v1/users/{userId}/settings/vacation. 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["gmailUsersSettings"]["gmailUsersSettingsGetVacation"]>[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.gmailUsersSettings.gmailUsersSettingsGetVacation(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.gmail_users_settings_get_vacation(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 Gets vacation responder settings For more information, see Manage vacation settings with the Gmail API (https: developers google com workspace gmail api guides vacation settings) — response body

Referenced models: Gets vacation responder settings For more information, see Manage vacation settings with the Gmail API (https: developers google com workspace gmail api guides vacation settings) — response body

Schemas

Gets vacation responder settings For more information, see Manage vacation settings with the Gmail API (https: developers google com workspace gmail api guides vacation settings) — response body

Field	Type	Presence	Description and constraints
$	object	Root	Vacation auto-reply settings for an account. These settings correspond to the "Vacation responder" feature in the web interface.
enableAutoReply	boolean	Optional	Flag that controls whether Gmail automatically replies to messages.
endTime	string	Optional	An optional end time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives before the end time. If both `startTime` and `endTime` are specified, `startTime` must precede `endTime`. Format: int64
responseBodyHtml	string	Optional	Response body in HTML format. Gmail will sanitize the HTML before storing it. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` will be used.
responseBodyPlainText	string	Optional	Response body in plain text format. If both `response_body_plain_text` and `response_body_html` are specified, `response_body_html` will be used.
responseSubject	string	Optional	Optional text to prepend to the subject line in vacation responses. In order to enable auto-replies, either the response subject or the response body must be nonempty.
restrictToContacts	boolean	Optional	Flag that determines whether responses are sent to recipients who are not in the user's list of contacts.
restrictToDomain	boolean	Optional	Flag that determines whether responses are sent to recipients who are outside of the user's domain. This feature is only available for Google Workspace users.
startTime	string	Optional	An optional start time for sending auto-replies (epoch ms). When this is specified, Gmail will automatically reply only to messages that it receives after the start time. If both `startTime` and `endTime` are specified, `startTime` must precede `endTime`. Format: int64

Policy, approvals and errors

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