Google: Lists the messages in the user's mailbox For more information, see List Gmail messages (https: developers google com workspace gmail api guides list-messages)

← gmail_users_messages operations · Get started · OpenAPI downloads

Contract 2026-10-27 · Operation google.gmail_users_messages_list

Provider route: GET /gmail/v1/users/{userId}/messages. 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["gmailUsersMessages"]["gmailUsersMessagesList"]>[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.gmailUsersMessages.gmailUsersMessagesList(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_messages.gmail_users_messages_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	The 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.
query.includeSpamTrash	boolean	Optional	Include messages from `SPAM` and `TRASH` in the results. Default: false
query.labelIds	array	Optional
query.labelIds[]	string	Each item	Only return messages with labels that match all of the specified label IDs. Messages in a thread might have labels that other messages in the same thread don’t have. To learn more, see [Manage labels on messages and threads](https://developers.google.com/workspace/gmail/api/guides/labels#manage_labels_on_messages_threads).
query.maxResults	integer	Optional	Maximum number of messages to return. This field defaults to 100. The maximum allowed value for this field is 500. Default: 100 Format: uint32
query.pageToken	string	Optional	Page token to retrieve a specific page of results in the list.
query.q	string	Optional	Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, `“from:someuser@example.com rfc822msgid: is:unread”`. Parameter cannot be used when accessing the api using the gmail.metadata scope.

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 messages in the user’s mailbox For more information, see List Gmail messages (https: developers google com workspace gmail api guides list-messages) — response body

Referenced models: Lists the messages in the user’s mailbox For more information, see List Gmail messages (https: developers google com workspace gmail api guides list-messages) — response body

Policy, approvals and errors

SDK function policy ID: google.gmail_users_messages_list. Catalog operation: gmail.users.messages.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.metadata", "https://www.googleapis.com/auth/gmail.modify", "https://www.googleapis.com/auth/gmail.readonly"]

Official provider source