Method: spaces.get

Returns details about a space. For an example, see Get details about a space .

Supports the following types of authentication :

  • App authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.spaces with administrator approval
  • User authentication with one of the following authorization scopes:

    • https://www.googleapis.com/auth/chat.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • User authentication grants administrator privileges when an administrator account authenticates, useAdminAccess is true , and one of the following authorization scopes is used:
      • https://www.googleapis.com/auth/chat.admin.spaces.readonly
      • https://www.googleapis.com/auth/chat.admin.spaces

App authentication has the following limitations:

  • space.access_settings is only populated when using the chat.app.spaces scope.
  • space.predefind_permission_settings and space.permission_settings are only populated when using the chat.app.spaces scope, and only for spaces the app created.

HTTP request

GET https://chat.googleapis.com/v1/{name=spaces/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Resource name of the space, in the form spaces/{space} .

Format: spaces/{space}

Query parameters

Parameters
useAdminAccess

boolean

Optional. When true , the method runs using the user's Google Workspace administrator privileges.

The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege .

Requires the chat.admin.spaces or chat.admin.spaces.readonly OAuth 2.0 scopes .

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Space .

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.admin.spaces.readonly
  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.app.spaces

For more information, see the Authorization guide .

Design a Mobile Site
View Site in Mobile | Classic
Share by: