---
title: "List User Group Members"
method: GET
path: "/api/v2/core/user-groups/{userGroupId}/users"
tags: ["User Groups"]
---

# List User Group Members

`GET /api/v2/core/user-groups/{userGroupId}/users`

## Request

- Base URL: `https://apiv2.eightfold.ai`
- URL: `https://apiv2.eightfold.ai/api/v2/core/user-groups/{userGroupId}/users`
- Auth: none declared. Required headers: `Authorization`
- TypeScript: <https://skmtc.dev/eightfold/apis/api-server-v2-service-service/docs/api/v2/core/user-groups/:userGroupId/users/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the members of a user group. Assigned members are read from the database, so an assignment is visible immediately; members matched by the group's rules are read from the search index and can lag a recent change. Every member carries a membershipType, and only static members can be removed.

## Path parameters

- `userGroupId` string, required

## Query parameters

- `start` integer
- `limit` integer
- `membershipType` string
- `exclude` string
- `keyList` string

## Headers

- `Authorization` string, required

## Response `200`

OK

- object
  - `data` UserGroupMemberSchema[]
    - `uuid` string, nullable: External unique identifier of the user
    - `userId` integer, nullable: Id of the user
    - `membershipType` string, nullable: static for an explicitly assigned member, dynamic for one matched by the group rules. Only static members can be removed
    - `firstName` string, nullable: First name of the user
    - `lastName` string, nullable: Last name of the user
    - `email` string, nullable: Email of the user
  - `meta` MetaSchema
    - `totalCount` integer, nullable
    - `pageTotalCount` integer, nullable
    - `pageStartIndex` integer, nullable

## Changes

- **2026-11-03** `9a8b3a927e93`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/eightfold/apis/api-server-v2-service-service/changes/api/v2/core/user-groups/:userGroupId/users/get.md)

---

[API](https://skmtc.dev/eightfold/apis/api-server-v2-service-service.md) - [All operations](https://skmtc.dev/eightfold/apis/api-server-v2-service-service/llms.txt) - [OpenAPI document](https://skmtc.dev/eightfold/apis/api-server-v2-service-service/revisions/9a8b3a927e93?raw)
