- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Format
- Try it!
Gets the specified thread.
HTTP request
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/threads/{id}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
userId
|
The user's email address. The special value |
id
|
The ID of the thread to retrieve. |
Query parameters
| Parameters | |
|---|---|
format
|
The format to return the messages in. |
metadataHeaders[]
|
When given and format is METADATA, only include headers specified. |
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Thread
.
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 .
Format
| Enums | |
|---|---|
full
|
Returns the full email message data with body content parsed in the payload
field; the raw
field is not used. Format cannot be used when accessing the api using the gmail.metadata scope. |
metadata
|
Returns only email message IDs, labels, and email headers. |
minimal
|
Returns only email message IDs and labels; does not return the email headers, body, or payload. |
