---
title: "Get user groups"
method: GET
path: "/api/v1/userGroups"
tags: ["Users"]
---

# Get user groups

`GET /api/v1/userGroups`

This endpoint enables you to gather information about the user groups in your organization's Soda Cloud account, including lists of members.

This GET is a paginated API that uses the following parameters to request specific details:

- `size`: Supply an integer value between 10 and 1000, inclusive. The default value is 1000.

- `page`: Supply an integer value. The default value is 0.

- `search`: Optionally, use this parameter to perform a fuzzy search on the user group name. 

If not specified, the query gathers information for all user groups in the account and sorts the results by user group name in ascending order.

## Authentication

User authentication required: `true`

This endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.

## Authorization

Any Soda Cloud user in your organization may execute this query.

## Tags

`Users`

## Rate limiting

60 requests/60 seconds

## Query parameters

- `page` integer
- `search` string
- `size` integer

## Response `200`

Successful response

- PublicApiUserGroupsResponse
  - `content` UserGroupContentDTO[], required
    - `name` string, required
    - `userGroupId` string, required
    - `users` UserContentDTO[], required
      - `email` string, required
      - `firstName` string
      - `fullName` string
      - `lastName` string
      - `userId` string, required
  - `first` boolean, required
  - `last` boolean, required
  - `number` integer, required
  - `size` integer, required
  - `totalElements` integer, required
  - `totalPages` integer, required

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `429` — Too many requests
- `500` — Internal server error

---

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