## ListMemberships

`groups.memberships.list(MembershipListParams**kwargs)  -> SyncMembersPage[GroupMembership]`

**post** `/gitpod.v1.GroupService/ListMemberships`

Lists all memberships of a group.

Use this method to:

- View all members of a group
- Audit group membership

### Examples

- List group members:

  Shows all members of a specific group.

  ```yaml
  groupId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  pagination:
    pageSize: 20
  ```

### Authorization

All organization members can view group membership (transparency model).

### Parameters

- `token: Optional[str]`

- `page_size: Optional[int]`

- `filter: Optional[Filter]`

  filter contains options for filtering the list of memberships.

  - `search: Optional[str]`

    search performs case-insensitive search across member name, email, ID,
    and service account name and description

- `group_id: Optional[str]`

- `pagination: Optional[Pagination]`

  pagination contains the pagination options for listing memberships

  - `token: Optional[str]`

    Token for the next set of results that was returned as next_token of a
    PaginationResponse

  - `page_size: Optional[int]`

    Page size is the maximum number of results to retrieve per page.
    Defaults to 25. Maximum 100.

### Returns

- `class GroupMembership: …`

  GroupMembership represents a subject's membership in a group

  - `id: Optional[str]`

    Unique identifier for the group membership

  - `avatar_url: Optional[str]`

    Subject's avatar URL

  - `group_id: Optional[str]`

    Group identifier

  - `name: Optional[str]`

    Subject's display name

  - `subject: Optional[Subject]`

    Subject (user, runner, environment, service account, etc.)

    - `id: Optional[str]`

      id is the UUID of the subject

    - `principal: Optional[Principal]`

      Principal is the principal of the subject

      - `"PRINCIPAL_UNSPECIFIED"`

      - `"PRINCIPAL_ACCOUNT"`

      - `"PRINCIPAL_USER"`

      - `"PRINCIPAL_RUNNER"`

      - `"PRINCIPAL_ENVIRONMENT"`

      - `"PRINCIPAL_SERVICE_ACCOUNT"`

      - `"PRINCIPAL_RUNNER_MANAGER"`

### Example

```python
import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
page = client.groups.memberships.list(
    group_id="d2c94c27-3b76-4a42-b88c-95a85e392c68",
    pagination={
        "page_size": 20
    },
)
page = page.members[0]
print(page.id)
```

#### Response

```json
{
  "members": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "avatarUrl": "avatarUrl",
      "groupId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "name": "name",
      "subject": {
        "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
        "principal": "PRINCIPAL_UNSPECIFIED"
      }
    }
  ],
  "pagination": {
    "nextToken": "nextToken"
  }
}
```