Get message with the Gmail API

Gets a message with its threadId, labelIds and snippet. With format full, the default, payload has the headers (From, To, Subject, Date, Message-ID) and the body parts, whose data is base64url encoded. Attachments come only as an attachmentId and are not downloaded.

Identifier
gmail_get_message

The request

POST https://connect.reportei.com/api/tools/gmail_get_message/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "messageId": "<messageId>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
messageIdstringYesMessage id from List messages, or the message.id of a draft from List drafts.
formatstringNofull returns the parsed payload, metadata only the headers, minimal only the ids and labels, and raw the whole RFC 2822 message base64url encoded in raw. The default is full.Values: full, metadata, minimal, raw
metadataHeadersarrayNoWith format metadata, returns only these headers, such as From, Subject and Message-ID.

Supported connections

Your customer connects their Gmail account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/gmail, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/gmail_get_message. It becomes your agent's tool definition with no conversion.

Other Gmail tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.