VeryReport · 帮助文档

QueryUserList - 用户列表

开放 API:分页查询租户用户列表,支持关键字与状态筛选。

1. 接口说明

分页列出当前租户下的用户。

请求方法:GET
请求路径:/api/open/v1/users

2. 认证

需要 HMAC 签名,详见 API 使用说明

3. 请求参数

3.2 查询参数

参数名类型必填说明
pageint页码,默认 1
pageSizeint每页条数,默认 20,最大 100
keywordstring按 loginName 模糊匹配
statusstring用户状态:0 正常,1 停用

4. 响应参数

4.1 成功响应示例

{
  "code": 0,
  "data": {
    "total": 1,
    "list": [{
      "userId": 1001,
      "loginName": "zhangsan",
      "username": "张三",
      "email": "",
      "phone": "",
      "status": "0"
    }]
  }
}

4.2 返回字段(data)

参数名类型必填说明
totallong-总记录数
listarray-用户列表
list[].userIdlong-用户 ID
list[].loginNamestring-登录名
list[].usernamestring-显示名称
list[].emailstring-邮箱
list[].phonestring-手机号
list[].statusstring-0 正常 / 1 停用
上一篇API使用说明下一篇QueryUserInfo - 用户详情