Method: spaces.findGroupChats

Returns all spaces with spaceType == GROUP_CHAT, whose human memberships contain exactly the calling user, and the users specified in FindGroupChatsRequest.memberships.

If the calling user blocks, or is blocked by, some users, and no spaces with the entire specified set of users are found, this method returns spaces that don't include the blocked or blocking users.

The specified set of users must contain only human (non-app) memberships. A request that contains non-human users doesn't return any spaces.

Requires user authentication with one of the following authorization scopes:

  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.memberships

HTTP request

GET https://chat.googleapis.com/v1/spaces:findGroupChats

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
user[]

string

Resource names of all human users in group chat with the calling user. Chat apps cannot be included in the request.

Format: users/{user}, where {user} is either the id for the person from the People API, or the id for the user in the Directory API. For example, to find all group chats with the calling user and two other users, with People API profile IDs 123456789 and 987654321, you can use users/123456789 and users/987654321. You can also use the email as an alias for {user}. For example, users/example@gmail.com where example@gmail.com is the email of the Google Chat user.

When the calling user is a Google Workspace user, all requested users must be members of the same Google Workspace organization as the calling user.
pageSize

integer

Optional. The maximum number of spaces to return. The service might return fewer than this value.

If unspecified, at most 100 spaces are returned.

The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000.

Negative values return an INVALID_ARGUMENT error.
pageToken

string

Optional. A page token, received from a previous call to find group chats. Provide this parameter to retrieve the subsequent page.

When paginating, all other parameters provided should match the call that provided the token. Passing different values may lead to unexpected results.
spaceView

enum (SpaceView)

Requested space view type. If unset, defaults to SPACE_VIEW_RESOURCE_NAME_ONLY. Requests that specify SPACE_VIEW_EXPANDED must include scopes that allow reading space data, for example, https://www.googleapis.com/auth/chat.spaces or https://www.googleapis.com/auth/chat.spaces.readonly.

Request body

The request body must be empty.

Response body

A response containing group chat spaces with exactly the calling user and the requested users.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string
}
Fields
spaces[]

object (Space)

List of spaces in the requested (or first) page.
nextPageToken

string

A token that you can send as pageToken to retrieve the next page of results. If empty, there are no subsequent pages.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

For more information, see the Authorization guide.

SpaceView

A view that specifies which fields should be populated on the Space resource. To ensure compatibility with future releases, we recommend that your code account for additional values..

Enums
SPACE_VIEW_UNSPECIFIED The default / unset value.
SPACE_VIEW_RESOURCE_NAME_ONLY Populates only the Space resource name.
SPACE_VIEW_EXPANDED Populates Space resource fields. Note: the permissionSettings field will not be populated. Requests that specify SPACE_VIEW_EXPANDED must include scopes that allow reading space data, for example, https://www.googleapis.com/auth/chat.spaces or https://www.googleapis.com/auth/chat.spaces.readonly.