- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Lists the threads in the user's mailbox.
HTTP request
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/threads
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
userId
|
The user's email address. The special value |
Query parameters
| Parameters | |
|---|---|
maxResults
|
Maximum number of threads to return. This field defaults to 100. The maximum allowed value for this field is 500. |
pageToken
|
Page token to retrieve a specific page of results in the list. |
q
|
Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, |
labelIds[]
|
Only return threads with labels that match all of the specified label IDs. |
includeSpamTrash
|
Include threads from |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{
"threads"
:
[
{
object (
|
| Fields | |
|---|---|
threads[]
|
List of threads. Note that each thread resource does not contain a list of |
nextPageToken
|
Page token to retrieve the next page of results in the list. |
resultSizeEstimate
|
Estimated total number of results. |
Authorization scopes
Requires one of the following OAuth scopes:
-
https://mail.google.com/ -
https://www.googleapis.com/auth/gmail.modify -
https://www.googleapis.com/auth/gmail.readonly -
https://www.googleapis.com/auth/gmail.metadata
For more information, see the Authorization guide .
