---
title: "List User Groups"
method: GET
path: "/api/v2/core/user-groups"
tags: ["User Groups"]
---

# List User Groups

`GET /api/v2/core/user-groups`

## Request

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

Returns a list of user groups, ordered by name. Both active and inactive user groups are returned by default; the isActive field carries the state. Member counts are not returned here; use the Get User Group endpoint for those.

## Query parameters

- `start` integer
- `limit` integer
- `onlyActive` boolean
- `userGroupName` string
- `exclude` string
- `keyList` string

## Headers

- `Authorization` string, required

## Response `200`

OK

- object
  - `data` UserGroupBaseSchema[]
    - `createdAt` integer, nullable: Create timestamp of the user group
    - `id` integer, nullable: Id of the user group
    - `isActive` boolean, nullable: Whether the user group is active
    - `description` string, nullable: Description of the user group
    - `productLine` string, nullable: Product line this user group applies to. Defaults to all product lines
    - `updatedAt` integer, nullable: Update timestamp of the user group
    - `role` string, nullable: Role granted to the members of the user group
    - `userGroupName` string, nullable: Name of the user group
  - `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/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)