Method: users.spaces.getSpaceReadState
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://chat.googleapis.com/v1/{name=users/*/spaces/*/spaceReadState}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
Required. Resource name of the space 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}/spaceReadState. Their Workspace email address. For example, users/user@example.com/spaces/{space}/spaceReadState. Their user id. For example, users/123456789/spaces/{space}/spaceReadState. Format: users/{user}/spaces/{space}/spaceReadState
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of SpaceReadState.
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\u003eThis document explains how to retrieve a user's read state within a Google Chat space, indicating read and unread messages.\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve read state information for the calling user using their user ID, email address, or the "me" alias.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires specific authorization scopes (\u003ccode\u003echat.users.readstate\u003c/code\u003e or \u003ccode\u003echat.users.readstate.readonly\u003c/code\u003e) for access.\u003c/p\u003e\n"],["\u003cp\u003eA successful response returns a \u003ccode\u003eSpaceReadState\u003c/code\u003e object containing details of the user's read state in the specified space.\u003c/p\u003e\n"],["\u003cp\u003eRefer to the provided links for a practical example and further details on authentication and authorization.\u003c/p\u003e\n"]]],["This resource retrieves a user's read state within a specific space to determine read/unread messages. It uses a `GET` HTTP request to `https://chat.googleapis.com/v1/{name=users/*/spaces/*/spaceReadState}`, employing gRPC Transcoding syntax. The `name` path parameter, which is required, identifies the user and space. The request body must be empty, while a successful response returns a `SpaceReadState` instance. User authentication with specified OAuth scopes is necessary.\n"],null,["# Method: users.spaces.getSpaceReadState\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 space, used to identify read and unread messages. For an example, see [Get details about a user's space read state](https://developers.google.com/workspace/chat/get-space-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/*/spaceReadState}`\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 space 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}/spaceReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/spaceReadState`. - Their user id. For example, `users/123456789/spaces/{space}/spaceReadState`. Format: users/{user}/spaces/{space}/spaceReadState |\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 [SpaceReadState](/workspace/chat/api/reference/rest/v1/users.spaces#SpaceReadState).\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)."]]
