Method: users.spaces.threads.getThreadReadState
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://chat.googleapis.com/v1/{name=users/*/spaces/*/threads/*/threadReadState}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. Resource name of the thread read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following:
The me alias. For example, users/me/spaces/{space}/threads/{thread}/threadReadState. Their Workspace email address. For example, users/user@example.com/spaces/{space}/threads/{thread}/threadReadState. Their user id. For example, users/123456789/spaces/{space}/threads/{thread}/threadReadState. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of ThreadReadState.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/chat.users.readstatehttps://www.googleapis.com/auth/chat.users.readstate.readonly
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-05-07 UTC.
[null,null,["Last updated 2025-05-07 UTC."],[[["\u003cp\u003eRetrieves a user's read state within a specific thread, indicating read and unread messages.\u003c/p\u003e\n"],["\u003cp\u003eRequires user authentication and uses a specific HTTP GET request format with path parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should be empty, while a successful response includes a \u003ccode\u003eThreadReadState\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003eAuthorisation is necessary, using specific OAuth scopes related to read state permissions.\u003c/p\u003e\n"]]],["This describes retrieving a user's read state within a specific thread. To do so, send a `GET` HTTP request to a URL constructed with user, space, and thread identifiers, using either the `me` alias, their email, or ID. The request body must be empty. Successful requests return a `ThreadReadState` object, and requests require authorization via OAuth scopes, such as `chat.users.readstate`. The user must be authenticated to access this resource.\n"],null,["# Method: users.spaces.threads.getThreadReadState\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns details about a user's read state within a thread, used to identify read and unread messages. For an example, see [Get details about a user's thread read state](https://developers.google.com/workspace/chat/get-thread-read-state).\n\nRequires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):\n\n- `https://www.googleapis.com/auth/chat.users.readstate.readonly`\n- `https://www.googleapis.com/auth/chat.users.readstate`\n\n### HTTP request\n\n`GET https://chat.googleapis.com/v1/{name=users/*/spaces/*/threads/*/threadReadState}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. Resource name of the thread read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/threads/{thread}/threadReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/threads/{thread}/threadReadState`. - Their user id. For example, `users/123456789/spaces/{space}/threads/{thread}/threadReadState`. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState |\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 [ThreadReadState](/workspace/chat/api/reference/rest/v1/users.spaces.threads#ThreadReadState).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/chat.users.readstate`\n- `https://www.googleapis.com/auth/chat.users.readstate.readonly`\n\nFor more information, see the [Authorization guide](/workspace/chat/authenticate-authorize)."]]
