Method: users.spaces.threads.getThreadReadState

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.

HTTP request


The URL uses gRPC Transcoding syntax.

Path parameters



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/{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:


For more information, see the Authorization guide.