---
title: "Retrieve list of user groups"
method: GET
path: "/api/v1/usergroups/list"
tags: ["User group"]
---

# Retrieve list of user groups

`GET /api/v1/usergroups/list`

## Query parameters

- `Limit` integer
- `Offset` integer
- `OrganizationId` integer
- `SortBy` string
- `SortDirection` string
- `Search` string
- `SearchId` string
- `Id` integer

## Response `200`

OK

- UserGroupList
  - `data` UserGroupDetailsListDto[], nullable, required
    - `id` integer, required
    - `name` string, nullable, required
    - `organizationId` integer, required
    - `organizationName` string, nullable, required
    - `users` UserListDto[], nullable, required
      - `id` string, nullable, required
      - `name` string, nullable, required
    - `projectGroups` ProjectGroupEntityListDto[], nullable, required
      - `id` integer, required
      - `name` string, nullable, required
  - `totalCount` integer, required

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `409` — Conflict
- `500` — Internal Server Error

---

[API](https://skmtc.dev/taikun/apis/taikun-webapi.md) · [All operations](https://skmtc.dev/taikun/apis/taikun-webapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/taikun/taikun-webapi/revisions/09395964d191/schema)