List admin menu permissions. GET /api/openapi/v1/admin-menu-permissions, scope admin.v1.admin-roles.read.
- Scope: admin.v1.admin-roles.read
- Permission: Read admin roles (admin-roles)
- Permission type: Read
- Endpoint: GET/api/openapi/v1/admin-menu-permissions
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
This endpoint has no additional request parameters.
Request example
cURL
Responses
200 OK
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
| menus | array ｜ null | Yes | Menu permissions | [{"code":"<string>","display_order":0,"parent_code":"<string>"}] |
| permissions | array ｜ null | Yes | Permissions | [{"action":"<string>","code":"<string>","description":"<string>","menu_code":"<string>","resource":"<string>"}] |
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>" |