Google: Gmail users threads schemas
3 Google schemas with complete fields and constraints.
← Gmail users threads operations · All schemas
Gets the specified thread For more information, see Manage threads (https: developers google com workspace gmail api guides threads) — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A collection of messages representing a conversation. |
historyId | string | Optional | The ID of the last history record that modified this thread. Format: uint64 |
id | string | Optional | The unique ID of the thread. |
messages | array | Optional | The list of messages in the thread. |
messages[] | Model | Each item | Expand Gets the specified message — response body |
snippet | string | Optional | A short part of the message text. |
Referenced models: Gets the specified message — response body
Lists the threads in the user's mailbox For more information, see Manage threads (https: developers google com workspace gmail api guides threads) — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
nextPageToken | string | Optional | Page token to retrieve the next page of results in the list. |
resultSizeEstimate | JSON | Optional | |
resultSizeEstimate (anyOf 1) | integer | Alternative | Estimated total number of results. Format: uint32 |
resultSizeEstimate (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
threads | array | 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`](https://developers.google.com/workspace/gmail/api/v1/reference/users/threads/get) method. |
threads[] | Model | Each item | Expand Gets the specified thread For more information, see Manage threads (https: developers google com workspace gmail api guides threads) — response body |
Referenced models: Gets the specified thread For more information, see Manage threads (https: developers google com workspace gmail api guides threads) — response body
Modifies the labels applied to the thread This applies to all messages in the thread For more information, see Manage threads (https: developers google com workspace gmail api guides threads) — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
addLabelIds | array | Optional | A list of IDs of labels to add to this thread. You can add up to 100 labels with each update. |
addLabelIds[] | string | Each item | |
removeLabelIds | array | Optional | A list of IDs of labels to remove from this thread. You can remove up to 100 labels with each update. |
removeLabelIds[] | string | Each item |