---
title: "ListMembers"
method: POST
path: "/gitpod.v1.OrganizationService/ListMembers"
tags: ["gitpod.v1.OrganizationService"]
---

# ListMembers

`POST /gitpod.v1.OrganizationService/ListMembers`

Lists and filters organization members with optional pagination.

 Use this method to:
 - View all organization members
 - Monitor member activity
 - Manage team membership

 ### Examples

 - List active members:

   Retrieves active members with pagination.

   ```yaml
   organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
   pagination:
     pageSize: 20
   ```

 - List with pagination:

   Retrieves next page of members.

   ```yaml
   organizationId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
   pagination:
     pageSize: 50
     token: "next-page-token-from-previous-response"
   ```

## Query parameters

- `pageSize` integer
- `token` string

## Request body

- GitpodV1ListMembersRequest
  - `count` GitpodV1CountRequest — CountRequest controls whether the response should include a bounded count of matching records.
    - `include` boolean — When true, the first page of results will include a CountResponse with the bounded total. Subsequent pages (requests with a pagination token) will not contain the count.
  - `filter` GitpodV1ListMembersRequestFilter
    - `excludeGroupIds` string[] — exclude_group_ids excludes members who are already in any of the specified groups
    - `excludeMembersInAnyTeam` boolean — exclude_members_in_any_team excludes members who belong to any team in the organization
    - `roles` GitpodV1OrganizationRole[] — roles filters members by their organization role
    - `search` string — search performs case-insensitive search across member name and email
    - `statuses` GitpodV1UserStatus[] — status filters members by their user status
    - `userIds` string[] — user_ids filters the response to only members with the specified user IDs
  - `organizationId` string, uuid, required — organization_id is the ID of the organization to list members for
  - `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
  - `sort` GitpodV1ListMembersRequestSort
    - `field` 'SORT_FIELD_UNSPECIFIED' | 'SORT_FIELD_NAME' | 'SORT_FIELD_DATE_JOINED'
    - `order` 'SORT_ORDER_UNSPECIFIED' | 'SORT_ORDER_ASC' | 'SORT_ORDER_DESC'

## Response `200`

Success

- GitpodV1ListMembersResponse
  - `count` GitpodV1CountResponse — CountResponse represents a bounded count of matching records. When the actual count exceeds the counting limit, value is capped and relation is set to GREATER_THAN_OR_EQUAL.
    - `relation` 'COUNT_RESPONSE_RELATION_UNSPECIFIED' | 'COUNT_RESPONSE_RELATION_EQ' | 'COUNT_RESPONSE_RELATION_GTE'
    - `value` integer — The count of matching records, capped at the server's counting limit.
  - `members` GitpodV1OrganizationMember[], required — members are the members of the organization
    - `avatarUrl` string
    - `email` string, required
    - `fullName` string, required
    - `loginProvider` string, required — login_provider is the login provider the user uses to sign in
    - `memberSince` string, date-time, required — A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`]( http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime() ) to obtain a formatter capable of generating timestamps in this format.
    - `role` 'ORGANIZATION_ROLE_UNSPECIFIED' | 'ORGANIZATION_ROLE_ADMIN' | 'ORGANIZATION_ROLE_MEMBER', required
    - `status` 'USER_STATUS_UNSPECIFIED' | 'USER_STATUS_ACTIVE' | 'USER_STATUS_SUSPENDED' | 'USER_STATUS_LEFT', required
    - `userId` string, uuid, required
  - `pagination` GitpodV1PaginationResponse, required
    - `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)