---
title: "Get List of User Groups"
method: GET
path: "/api/access/v1/user-groups"
tags: ["User Groups"]
---

# Get List of User Groups

`GET /api/access/v1/user-groups`

Use this API to retrieve a list of user groups.

## Query parameters

- `filters` string
- `page` integer
- `size` integer
- `sort` 'name,asc' | 'name,desc' | 'description,asc' | 'description,desc' | 'createdDate,asc' | 'createdDate,desc' | 'lastModifiedDate,asc'

## Response `200`

OK

- PlatformAccessManagementPageUserGroupResponse
  - `content` PlatformAccessManagementUserGroupResponse[] — The list of user groups in the current page.
    - `userGroupId` string, uuid — The unique identifier of the user group.
    - `name` string — The name of the user group.
    - `description` string — The brief description of the user group.
    - `createdBy` string, uuid — The unique identifier of the user who created this record.
    - `createdDate` string, date-time — The date and time the record was created.
    - `lastModifiedBy` string, uuid — The unique identifier of the user who last modified the record.
    - `lastModifiedDate` string, date-time — The date and time the record was last modified.
  - `empty` boolean — Indicates whether the result set is empty.
  - `first` boolean — Indicates whether this is the first page.
  - `last` boolean — Indicates whether this is the last page.
  - `number` integer — The current page number.
  - `numberOfElements` integer — The number of records in the current page.
  - `size` integer — The total number of records across all pages.
  - `totalElements` integer — The total number of pages available.
  - `totalPages` integer — The pagination details for this response.
  - `sort` PlatformAccessManagementSortObject
    - `empty` boolean — Indicates whether the result set is empty, meaning no records were found.
    - `sorted` boolean — Indicates whether the results are sorted in a specific order, such as ascending or descending.
    - `unsorted` boolean — The indicator of whether the results are unsorted.
  - `pageable` object — The pagination details for this response.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500` — Internal Server Error

---

[API](https://skmtc.net/onetrust/apis/platform-access-management.md) · [All operations](https://skmtc.net/onetrust/apis/platform-access-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onetrust/platform-access-management/versions/21de3aa0b170/schema)