Method: users.threads.get
Stay organized with collections
Save and categorize content based on your preferences.
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 |
string
The user's email address. The special value me can be used to indicate the authenticated user.
|
id |
string
The ID of the thread to retrieve.
|
Query parameters
| Parameters |
format |
enum (Format)
The format to return the messages in.
|
metadataHeaders[] |
string
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-24 UTC.
[null,null,["Last updated 2025-03-24 UTC."],[],[],null,["# Method: users.threads.get\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Format](#Format)\n- [Try it!](#try-it)\n\nGets the specified thread.\n\n### HTTP request\n\n`GET https://gmail.googleapis.com/gmail/v1/users/{userId}/threads/{id}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-----------------------------------------------------------------------------------------------------------|\n| `userId` | `string` The user's email address. The special value `me` can be used to indicate the authenticated user. |\n| `id` | `string` The ID of the thread to retrieve. |\n\n### Query parameters\n\n| Parameters ||\n|---------------------|----------------------------------------------------------------------------------------------------------------------------|\n| `format` | `enum (`[Format](/workspace/gmail/api/reference/rest/v1/users.threads/get#Format)`)` The format to return the messages in. |\n| `metadataHeaders[]` | `string` When given and format is METADATA, only include headers specified. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [Thread](/workspace/gmail/api/reference/rest/v1/users.threads#Thread).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://mail.google.com/`\n- `\n https://www.googleapis.com/auth/gmail.modify`\n- `\n https://www.googleapis.com/auth/gmail.readonly`\n- `\n https://www.googleapis.com/auth/gmail.metadata`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nFormat\n------\n\n| Enums ||\n|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n| `metadata` | Returns only email message IDs, labels, and email headers. |\n| `minimal` | Returns only email message IDs and labels; does not return the email headers, body, or payload. |"]]
