Gmail API

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

GET

users

Lists the threads in the user's mailbox.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://gmail.googleapis.com//gmail/v1/users//threads'

Response Example

{
  "nextPageToken": "string",
  "resultSizeEstimate": 0,
  "threads": [
    {
      "historyId": "string",
      "id": "string",
      "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"
        }
      ],
      "snippet": "string"
    }
  ]
}

Request

Path Params

userId

string

required

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

Query Params

includeSpamTrash

string

optional

Include threads from SPAM and TRASH in the results.

labelIds

array[string]

optional

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

maxResults

integer

optional

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

pageToken

string

optional

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

string

optional

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.

Responses

🟢200Successful response

application/json

Body

nextPageToken

string

optional

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

resultSizeEstimate

integer <uint32>

optional

Estimated total number of results.

threads

array[object (Thread) {4}]

optional

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.

historyId

string <uint64>

optional

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

string

optional

The unique ID of the thread.

messages

array[object (Message) {9}]

optional

The list of messages in the thread.

snippet

string

optional

A short part of the message text.

Modified at 2023-08-15 05:40:23

/gmail/v1/users/{userId}/stop

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