Method: users.spaces.threads.getThreadReadState

  • Retrieves a user's read state within a specific thread, indicating read and unread messages.

  • Requires user authentication and uses a specific HTTP GET request format with path parameters.

  • The request body should be empty, while a successful response includes a ThreadReadState object.

  • Authorisation is necessary, using specific OAuth scopes related to read state permissions.

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

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

For more information, see the Authorization guide.