GET/api/v1/admin/users检索用户

Try it 面板需要启用 JavaScript。

分页检索全部用户，支持关键词与状态过滤。

Request

Headers

Name	Data Type	Required	Description
Authorization	string	Yes	会话令牌认证，格式 `Bearer <sessionToken>`

type RequestHeaders = {
  /** 会话令牌认证，格式 `Bearer <sessionToken>` */
  Authorization: string
}

Query Parameters

Name	Data Type	Required	Description
page	number	No	页码，默认 1
pageSize	number	No	每页数量，默认 20，上限 100
keyword	string	No	按用户名 / 昵称 / 手机号 / 邮箱模糊匹配
status	string	No	按状态过滤：active / frozen

type QueryParams = {
  /** 页码，默认 1 */
  page?: number
  /** 每页数量，默认 20，上限 100 */
  pageSize?: number
  /** 按用户名 / 昵称 / 手机号 / 邮箱模糊匹配 */
  keyword?: string
  /** 按状态过滤：active / frozen */
  status?: string
}

{
  "page": 1,
  "pageSize": 20,
  "keyword": "chen",
  "status": "active"
}

Response

Body

Name	Data Type	Required	Description
items	array	Yes	用户列表
total	number	Yes	总数
page	number	Yes	当前页码
pageSize	number	Yes	每页数量

type ResponseBody = {
  /** 用户列表 */
  items: Record<string, unknown>[]
  /** 总数 */
  total: number
  /** 当前页码 */
  page: number
  /** 每页数量 */
  pageSize: number
}

{
  "items": [
    {
      "userId": "01JD8SEGQ0P9N2XK4L7VDH3T6C",
      "username": "chenlin",
      "displayName": "陈林",
      "status": "active",
      "createdAt": "2026-10-14T08:05:00Z",
      "lastLoginAt": "2026-10-14T08:00:00Z"
    }
  ],
  "total": 128,
  "page": 1,
  "pageSize": 20
}

HTTP Code

HTTP Status	Meaning	Notes
200	成功	返回用户列表

Response Code

响应使用统一信封 {id, code, messages, result}，其 code 字段：

code	Meaning	Notes
0	成功	返回用户列表

Examples

GET /api/v1/admin/users?page=1&pageSize=20&keyword=chen&status=active
Authorization: Bearer st_7c1f9e05b28d4a63

{
  "id": "01JD8SSYOT3O6QG",
  "code": 0,
  "messages": [],
  "result": {
    "items": [
      {
        "userId": "01JD8SEGQ0P9N2XK4L7VDH3T6C",
        "username": "chenlin",
        "displayName": "陈林",
        "status": "active",
        "createdAt": "2026-10-14T08:05:00Z",
        "lastLoginAt": "2026-10-14T08:00:00Z"
      }
    ],
    "total": 128,
    "page": 1,
    "pageSize": 20
  }
}