Method: users.spaces.getSpaceReadState

  • This document explains how to retrieve a user's read state within a Google Chat space, indicating read and unread messages.

  • You can retrieve read state information for the calling user using their user ID, email address, or the "me" alias.

  • The request requires specific authorization scopes (chat.users.readstate or chat.users.readstate.readonly) for access.

  • A successful response returns a SpaceReadState object containing details of the user's read state in the specified space.

  • Refer to the provided links for a practical example and further details on authentication and authorization.

Returns 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.

Requires user authentication with one of the following authorization scopes:

  • https://www.googleapis.com/auth/chat.users.readstate.readonly
  • https://www.googleapis.com/auth/chat.users.readstate

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.readstate
  • https://www.googleapis.com/auth/chat.users.readstate.readonly

For more information, see the Authorization guide.