List memberships

This guide explains how to list a membership with the Google Chat API. List memberships to see a paginated, filterable list of memberships 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.

Prerequisites

Python

Python 3.6 or greater
The pip package management tool
The Google client libraries for Python. To install them, run the following command in your command-line interface:
```
pip3 install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib oauth2client
```
A published Chat app. To create and publish a Chat app, see Build a Google Chat app.
Authorization configured for the Chat app. Listing memberships supports both of the following authentication methods:
- User authentication with the chat.memberships.readonly or chat.memberships authorization scope.
- App authentication with the chat.bot authorization scope.

List memberships with user authentication

To asynchronously list memberships in Google Chat, pass the following in your request:

With user authentication, specify the chat.memberships.readonly or chat.memberships authorization scope.
Call the list method on the Member resource.

The following example lists human space members (not space managers) visible to the authenticated user because filter is set to ROLE_Member:

Python

In your working directory, create a file named chat_member_list_user.py.

Include the following code in chat_member_list_user.py:

import os.path

from google.auth.transport.requests import Request
from google.oauth2.credentials import Credentials
from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build
from googleapiclient.errors import HttpError

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.memberships.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then lists human space members (but not space managers) in a
    specified space.
    '''

    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                'client_secrets.json', SCOPES)
    creds = flow.run_local_server()

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds)

    # Use the service endpoint to call Chat API.
    result = chat.spaces().members().list(

        # The space for which to list memberships.
        parent = 'spaces/SPACE',

        # An optional filter that returns only human space members.
        filter = 'member.type = "HUMAN" AND role = "ROLE_MEMBER"'

    ).execute()

    # Prints details about the created membership.
    print(result)

if __name__ == '__main__':
    main()

In the code, replace SPACE with a space name, which you can obtain from the spaces.list method in the Chat API, or from a space's URL.
In your working directory, build and run the sample:
```
python3 chat_member_list_user.py
```

The Google Chat API returns a list of human space members (excluding space managers) and app members from the specified space.

List memberships with app authentication

To asynchronously list memberships in Google Chat, pass the following in your request:

With app authentication, specify the chat.bot authorization scope.
Call the list method on the Member resource.

The following example lists human space members (not space managers) visible to the Chat app:

Python

In your working directory, create a file named chat_member_list_app.py.

Include the following code in chat_member_list_app.py:

from httplib2 import Http
from oauth2client.service_account import ServiceAccountCredentials
from apiclient.discovery import build

# Specify required scopes.
SCOPES = ['https://www.googleapis.com/auth/chat.bot']

# Specify service account details.
CREDENTIALS = ServiceAccountCredentials.from_json_keyfile_name(
    'service_account.json', SCOPES)

# Build the URI and authenticate with the service account.
chat = build('chat', 'v1', http=CREDENTIALS.authorize(Http()))

# Use the service endpoint to call Chat API.
result = chat.spaces().members().list(

        # The space for which to list memberships.
        parent = 'spaces/SPACE',

        # An optional filter that returns only human space members.
        filter = 'member.type = "HUMAN" AND role = "ROLE_MEMBER"'

    ).execute()

print(result)

In the code, replace SPACE with a space name, which you can obtain from the spaces.list method in the Chat API, or from a space's URL.
In your working directory, build and run the sample:
```
python3 chat_member_list_app.py
```

The Google Chat API returns a list of human space members (excluding space managers) from the specified space.

Customize pagination or filter the list

To asynchronously list the memberships, pass the following query parameters to customize pagination of, or filter, listed memberships:

pageSize: The maximum number of memberships to return. The service might return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1,000; values above 1,000 are automatically changed to 1,000.
pageToken: A page token, received from a previous list spaces call. Provide this token to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.
filter: A query filter. Requires user authentication. For supported query details, see the spaces.members.list method.