---
title: "Search user groups"
method: POST
path: "/app/v1/user_groups/search"
tags: ["user_groups"]
---

# Search user groups

`POST /app/v1/user_groups/search`

## Request body

- object
  - `page` number — Which page to return
  - `page_size` number — How many items to list in a page
  - `sort_by` 'id' | 'name' | 'group_category_id' | 'created_at' | 'updated_at' | 'created_by' | 'updated_by'
  - `sort_direction` 'asc' | 'desc' — Sort direction
  - `filter` object — A filter object for User Groups where it can filter based on any of these following fields. No fields are mandatory and the syntax is roughly the same as MongoDB querying.
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `created_by` string, uuid
    - `updated_by` string, uuid
    - `id` string, uuid
    - `name` string
    - `group_category_id` string, uuid
    - `user.id` string, uuid

## Response `200`

successful operation

- PagedUserGroupList
  - `page_number` number
  - `page_size` number
  - `total_entries` number
  - `total_pages` number
  - `data` UserGroup[]
    - `name` string
    - `description` string
    - `group_category_id` string, uuid
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `created_by` string, uuid
    - `updated_by` string, uuid
    - `id` string, uuid
    - `company_id` string, uuid

---

[API](https://skmtc.net/validere/apis/carbonhub-api.md) · [All operations](https://skmtc.net/validere/apis/carbonhub-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/validere/carbonhub-api/revisions/053edab62415/schema)