---
title: "Searches user groups based on the specified searchRequest."
method: GET
path: "/groups"
tags: ["Groups"]
---

# Searches user groups based on the specified searchRequest.

`GET /groups`

## Query parameters

- `GroupName` string
- `OrderBy` string
- `Descending` boolean
- `Paged` boolean
- `PageNumber` integer
- `PageSize` integer

## Response `200`

The user groups that match the specified searchRequest.

- UserGroupDtoPagingResult
  - `data` UserGroupDto[], nullable
    - `groupId` string, uuid, nullable
    - `name` string, nullable
    - `type` 'ProjectAdmin' | 'Custom' | 'Default'
    - `access` 'None' | 'Read' | 'Create' | 'Edit' | 'Delete'
    - `users` UserGroupMemberDto[], nullable
      - `id` integer
      - `email` string, nullable
  - `pageNumber` integer, nullable
  - `pageSize` integer, nullable
  - `totalRecords` integer
  - `totalPages` integer, nullable

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.dev/gridfox/apis/gridfox-public-api.md) · [All operations](https://skmtc.dev/gridfox/apis/gridfox-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/gridfox/gridfox-public-api/revisions/e1a1b07aa38c/schema)