Gmail.users.messages.list

Lists the messages in the user's mailbox.

GET/gmail/v1/users/{userId}/messages

Use it in a workflow

Add a step and choose the Gmail connector.
Pick the Gmail.users.messages.list action (under users).
Fill in the fields below, then reference the result from later steps as {{gmailUsersMessagesList.response.data}}.

Request

Path parameters

userIdstringrequired

The user's email address. The special value `me` can be used to indicate the authenticated user.

Query parameters

$.xgafvstring

V1 error format.

One of12

access_tokenstring

OAuth access token.

altstring

Data format for response.

One ofjsonmediaproto

callbackstring

JSONP

fieldsstring

Selector specifying which fields to include in a partial response.

keystring

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

oauth_tokenstring

OAuth 2.0 token for the current user.

prettyPrintboolean

Returns response with indentations and line breaks.

quotaUserstring

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.

upload_protocolstring

Upload protocol for media (e.g. "raw", "multipart").

uploadTypestring

Legacy upload protocol for media (e.g. "media", "multipart").

includeSpamTrashboolean

Include messages from `SPAM` and `TRASH` in the results.

labelIdsarray<string>

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/gmail/api/guides/labels#manage_labels_on_messages_threads).

maxResultsinteger

Maximum number of messages to return. This field defaults to 100. The maximum allowed value for this field is 500.

pageTokenstring

Page token to retrieve a specific page of results in the list.

qstring

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

Returns 200 with an object. Read it in later steps with {{gmailUsersMessagesList.response.data.<field>}}.

messagesarray<object>

List of messages. Note that each message resource contains only an `id` and a `threadId`. Additional message details can be fetched using the messages.get method.

historyIdstring (uint64)

The ID of the last history record that modified this message.

idstring

The immutable ID of the message.

internalDatestring (int64)

The internal message creation timestamp (epoch ms), which determines ordering in the inbox. For normal SMTP-received email, this represents the time the message was originally accepted by Google, which is more reliable than the `Date` header. However, for API-migrated mail, it can be configured by client to be based on the `Date` header.

labelIdsarray<string>

List of IDs of labels applied to this message.

payloadobject6 fields

A single MIME message part.

rawstring (byte)

The entire email message in an RFC 2822 formatted and base64url encoded string. Returned in `messages.get` and `drafts.get` responses when the `format=RAW` parameter is supplied.

sizeEstimateinteger (int32)

Estimated size in bytes of the message.

snippetstring

A short part of the message text.

threadIdstring

The ID of the thread the message belongs to. To add a message or draft to a thread, the following criteria must be met: 1. The requested `threadId` must be specified on the `Message` or `Draft.Message` you supply with your request. 2. The `References` and `In-Reply-To` headers must be set in compliance with the [RFC 2822](https://tools.ietf.org/html/rfc2822) standard. 3. The `Subject` headers must match.

nextPageTokenstring

Token to retrieve the next page of results in the list.

resultSizeEstimateinteger (uint32)

Estimated total number of results.

json

{
  "messages": [
    {
      "historyId": "string",
      "id": "string",
      "internalDate": "string",
      "labelIds": [
        "string"
      ],
      "payload": {
        "body": {
          "attachmentId": "string",
          "data": "string",
          "size": 0
        },
        "filename": "string",
        "headers": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "mimeType": "string",
        "partId": "string",
        "parts": [
          {}
        ]
      },
      "raw": "string",
      "sizeEstimate": 0,
      "snippet": "string",
      "threadId": "string"
    }
  ],
  "nextPageToken": "string",
  "resultSizeEstimate": 0
}

Need more? See the Gmail guide for connection setup and behaviour shared by every action.

Was this page helpful?