List user groups. GET /api/openapi/v1/user-groups, scope admin.v1.user-groups.read.
- Scope: admin.v1.user-groups.read
- Permission: Read user groups (user-groups)
- Permission type: Read
- Endpoint: GET/api/openapi/v1/user-groups
Authentication and request headers
Call with an application API key. This endpoint checks only the scope above; read, manage and execute permissions do not imply one another.
| Name | Location | Type | Required | Description | Example |
|---|---|---|---|---|---|
| Authorization | header | string | Yes | Application API key, passed as a Bearer token. | Bearer qwk_*** |
| X-Request-Id | header | string | No | Optional request tracing identifier; generated by the server if omitted. | req-20260831-001 |
Request parameters
| Name | Location | Type | Required | Description | Example |
|---|---|---|---|---|---|
| keyword | query | string | No | Search keyword | "<string>" |
| page | query | integer · int64 | No | Page number | 1 |
| page_size | query | integer · int64 | No | Page size | 20 |
Request example
cURL
Responses
200 OK
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| items | array ｜ null | Yes | User groups | [{"created_at":"2026-08-27T10:00:00Z","department_count":0,"description":"<string>","direct_user_count":0,"id":"<string>","name":"<string>","updated_at":"2026-08-27T10:00:00Z"}] |
| page | integer · int64 | Yes | Page number | 0 |
| page_size | integer · int64 | Yes | Page size | 0 |
| total_items | integer · int64 | Yes | Total count | 0 |
| total_pages | integer · int64 | Yes | Total pages | 0 |
default Flat business error
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| code | string | No | Stable business error code | "<string>" |
| detail | string | Yes | Human-readable error description | "<string>" |
| details | OpenapiErrorDetails | No | Error details | {"field":"<string>","reason":"<string>","suggestion":"<string>"} |
| details.field | string | No | Request field that failed validation | "<string>" |
| details.reason | string | No | Stable validation failure reason | "<string>" |
| details.suggestion | string | No | Suggested normalized value | "<string>" |
| error | string | Yes | Stable HTTP error type | "<string>" |