- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Lists memberships in a space. For an example, see List users and Google Chat apps in a space. Listing memberships with app authentication lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with User authentication lists memberships in spaces that the authenticated user has access to.
Supports the following types of authentication:
User authentication You can authenticate and authorize this method with administrator privileges by setting the
useAdminAccess
field in the request.
HTTP request
GET https://chat.googleapis.com/v1/{parent=spaces/*}/members
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The resource name of the space for which to fetch a membership list. Format: spaces/{space} |
Query parameters
Parameters | |
---|---|
pageSize |
Optional. The maximum number of memberships to return. The service might return fewer than this value. If unspecified, at most 100 memberships 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 |
pageToken |
Optional. A page token, received from a previous call to list memberships. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results. |
filter |
Optional. A query filter. You can filter memberships by a member's role ( To filter by role, set To filter by type, set To filter by both role and type, use the Either For example, the following queries are valid:
The following queries are invalid:
Invalid queries are rejected by the server with an |
showGroups |
Optional. When |
showInvited |
Optional. When Currently requires user authentication. |
useAdminAccess |
When The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege. Requires either the Listing app memberships in a space isn't supported when using admin access. |
Request body
The request body must be empty.
Response body
Response to list memberships of the space.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"memberships": [
{
object ( |
Fields | |
---|---|
memberships[] |
Unordered list. List of memberships in the requested (or first) page. |
nextPageToken |
A token that you can send as |
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.import
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.