---
title: "Search User Groups"
method: GET
path: "/v1/web/user-group"
tags: ["User Group"]
---

# Search User Groups

`GET /v1/web/user-group`

## Query parameters

- `ids` string
- `externalIds` string
- `userIds` string
- `managerIds` string
- `type` union
  - 'team'
  - 'location'
  - 'custom'
- `statuses` string
- `nameLike` string
- `createdAt` string
- `updatedAt` string
- `page` number
- `pageSize` number
- `orderBy` string

## Response `200`

Default Response

- object
  - `items` object[], required
    - `id` string, required
    - `externalId` string
    - `name` string, required
    - `status` union, required
      - 'active'
      - 'deleted'
    - `type` union, required
      - 'team'
      - 'location'
      - 'custom'
    - `budget` string
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `hasNext` boolean, required
  - `totalCount` number, required

## Other responses

- `400` — Default Response
- `401` — The access to this resource has been denied
- `403` — The access to this resource is forbidden
- `default` — Catch-all error response for any unexpected internal errors

---

[API](https://skmtc.net/funneldash/apis/surface-web-api.md) · [All operations](https://skmtc.net/funneldash/apis/surface-web-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/funneldash/surface-web-api/revisions/ac700d65f443/schema)