---
title: "Search user groups"
method: GET
path: "/v1/UserGroups"
tags: ["UserGroups"]
---

# Search user groups

`GET /v1/UserGroups`

Search for one or more user groups.

## Query parameters

- `search.user_group_id` integer[]
- `search.group_type` 'TASK' | 'TICKET' | 'PREORDER' | 'ORDER' | 'NOTIFICATION' | 'REQUEST'
- `search.name` string[]
- `search.active` boolean
- `search.page_size` integer
- `search.page` integer
- `search.sort` string

## Response `200`

OK

- RevWebAPIModelsGetOrSearchOfRevAppSearchModelsResponseOfRevAppModelsUserGroup
  - `ok` boolean
  - `has_more` boolean — Helper for pagination. Indicates there are more records returned.
  - `record_count` integer — Total number of records found by the search.
  - `records` RevAppModelsUserGroup[] — List of records returned.
    - `user_group_id` integer — Primary identifier for this user group.
    - `group_type` 'TASK' | 'TICKET' | 'PREORDER' | 'ORDER' | 'NOTIFICATION' | 'REQUEST', required — Indicates the kind of group this represents. Used for programmatic decisions by Rev.io.
    - `name` string, required — Short description of the group.
    - `group_email` string — Comma separated list of contact emails.
    - `description` string — Detailed description of the group.
    - `users` integer[] — List of user identifiers, indicating membership to the group.
    - `active` boolean, required — Indicates whether this group can be assigned.
    - `links` RevAppComponentsLink[]
      - `rel` string
      - `href` string

## Other responses

- `500` — InternalServerError

---

[API](https://skmtc.net/rev-io/apis/rev-io-api.md) · [All operations](https://skmtc.net/rev-io/apis/rev-io-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rev-io/rev-io-api/revisions/135571434f6c/schema)