---
title: "ListMemberships"
method: POST
path: "/gitpod.v1.GroupService/ListMemberships"
tags: ["gitpod.v1.GroupService"]
---

# ListMemberships

`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).

## Query parameters

- `pageSize` integer
- `token` string

## Request body

- GitpodV1ListMembershipsRequest — ListMemberships messages
  - `filter` GitpodV1ListMembershipsRequestFilter
    - `search` string — search performs case-insensitive search across member name, email, ID, and service account name and description
  - `groupId` string, uuid
  - `pagination` GitpodV1PaginationRequest
    - `pageSize` integer — Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100.
    - `token` string — Token for the next set of results that was returned as next_token of a PaginationResponse

## Response `200`

Success

- GitpodV1ListMembershipsResponse
  - `members` GitpodV1GroupMembership[]
    - `avatarUrl` string — Subject's avatar URL
    - `groupId` string, uuid — Group identifier
    - `id` string, uuid — Unique identifier for the group membership
    - `name` string — Subject's display name
    - `subject` GitpodV1Subject
      - `id` string, uuid — id is the UUID of the subject
      - `principal` 'PRINCIPAL_UNSPECIFIED' | 'PRINCIPAL_ACCOUNT' | 'PRINCIPAL_USER' | 'PRINCIPAL_RUNNER' | 'PRINCIPAL_ENVIRONMENT' | 'PRINCIPAL_SERVICE_ACCOUNT' | 'PRINCIPAL_RUNNER_MANAGER'
  - `pagination` GitpodV1PaginationResponse
    - `nextToken` string — Token passed for retrieving the next set of results. Empty if there are no more results

## Other responses

- `default` — Error

---

[API](https://skmtc.net/gitpod-io/apis/gitpod-v1.md) · [All operations](https://skmtc.net/gitpod-io/apis/gitpod-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gitpod-io/gitpod-v1/revisions/44d50c2ac284/schema)