Method: spaces.members.get

AI-generated Key Takeaways

• Returns detailed information about a specific Google Chat membership within a space.

• Supports both app and user authentication, with an option for user authentication to leverage administrator privileges.

• Requires providing the membership's resource name in the request path, allowing the use of email aliases for member identification.

• Optionally accepts a query parameter to utilize the user's Google Workspace administrator privileges for the request.

• Needs authorization with specific OAuth scopes related to Chat memberships and administration.

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
• Authorization scopes
• Try it!

Returns details about a membership. For an example, see Get details about a user's or Google Chat app's membership.

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.memberships (requires administrator approval)

• User authentication with one of the following authorization scopes:

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

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name	string Required. Resource name of the membership to retrieve. To get the app's own membership by using user authentication, you can optionally use spaces/{space}/members/app. Format: spaces/{space}/members/{member} or spaces/{space}/members/app You can use the user's email as an alias for {member}. For example, spaces/{space}/members/[e-mail] where [e-mail] is the email of the Google Chat user.

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.memberships or chat.admin.memberships.readonly OAuth 2.0 scopes. Getting app memberships in a space isn't supported when using admin access.

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authorization guide.