Gmail.users.threads.list

Lists the threads in the user's mailbox.

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

Use it in a workflow

Add a step and choose the Gmail connector.
Pick the Gmail.users.threads.list action (under users).
Fill in the fields below, then reference the result from later steps as {{gmailUsersThreadsList.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 threads from `SPAM` and `TRASH` in the results.

labelIdsarray<string>

Only return threads with labels that match all of the specified label IDs.

maxResultsinteger

Maximum number of threads 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 threads 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 {{gmailUsersThreadsList.response.data.<field>}}.

nextPageTokenstring

Page token to retrieve the next page of results in the list.

resultSizeEstimateinteger (uint32)

Estimated total number of results.

threadsarray<object>

List of threads. Note that each thread resource does not contain a list of `messages`. The list of `messages` for a given thread can be fetched using the threads.get method.

historyIdstring (uint64)

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

idstring

The unique ID of the thread.

messagesarray<object>9 fields

The list of messages in the thread.

snippetstring

A short part of the message text.

json

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

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

Was this page helpful?