---
title: "Returns a paginated list of simplified users groups."
method: GET
path: "/api/v1/UsersGroups"
tags: ["UsersGroups"]
---

# Returns a paginated list of simplified users groups.

`GET /api/v1/UsersGroups`

## Query parameters

- `cursor` string

## Headers

- `X-API-SECRET` string, required — API Secret is used to verify the integrity of the request and authenticate the client. It should be included in all requests. This value must be kept confidential and should never be exposed in client-side code or public repositories.

## Response `200`

OK

- UsersGroupSimplifiedListViewModelV1 — Paginated response for a list of entities and pagination-related links.
  - `data` UsersGroupSimplifiedViewModelV1[], required — The list of entities in the current page of the result.
    - `id` string, uuid, required — Unique identifier of the users group.
    - `name` string, required — Name of the users group.
    - `isIdpGroup` boolean — Indicates whether the users group has been imported from the identity provider.
    - `description` string, nullable — Optional description of the users group.
    - `isReadOnly` boolean — For synched groups with bi-directional synch, this flag is true if it is a group that can't be modified by Cakewalk
  - `links` LinksViewModel, required — Pagination-related URLs for navigating a paginated collection.
    - `self` string, required — URL to the current resource or page.
    - `next` string, nullable — URL to the next page in the collection, if available.

## Other responses

- `401` — Unauthorized
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/cakewalk/apis/cakewalk-open-api.md) · [All operations](https://skmtc.net/cakewalk/apis/cakewalk-open-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cakewalk/cakewalk-open-api/revisions/5728f183a29d/schema)