---
title: "Search groups by groupname"
method: GET
path: "/usergroups/search"
tags: ["usergroup"]
---

# Search groups by groupname

`GET /usergroups/search`

This endpoint is to search groups by group name.  It's open for all authenticated requests.

## Query parameters

- `page` integer
- `page_size` integer
- `groupname` string, required

## Headers

- `X-Request-Id` string

## Response `200`

Search groups successfully.

- UserGroupSearchItem[]
  - `id` integer — The ID of the user group
  - `group_name` string — The name of the user group
  - `group_type` integer — The group type, 1 for LDAP group, 2 for HTTP group, 3 for OIDC group.

## Other responses

- `401` — Unauthorized
- `409` — Conflict
- `500` — Internal server error

---

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