Lists memberships in a space.
Requires authentication. Fully supports service account authentication.
Supports user authentication as part of the Google Workspace Developer Preview Program, which grants early access to certain features. User authentication requires the chat.memberships
or chat.memberships.readonly
authorization scope.
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 |
The maximum number of memberships to return. The service may return fewer than this value. If unspecified, at most 100 memberships are returned. The maximum value is 1000; values above 1000 are coerced to 1000. Negative values return an INVALID_ARGUMENT error. |
pageToken |
A page token, received from a previous call to list memberships. Provide this 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 may 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 For example, the following queries are valid:
The following queries are invalid:
Invalid queries are rejected by the server with an |
showInvited |
Optional. When Currently requires user authentication. |
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"memberships": [
{
object ( |
Fields | |
---|---|
memberships[] |
List of memberships in the requested (or first) page. |
nextPageToken |
A token that can be sent as |
Authorization Scopes
Requires one of the following OAuth scopes:
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.