GET 用户列表
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 后台接口 |
| 请求方式 | GET |
| 接口地址 | /DIR_ADMIN/v1/client |
| 所属业务 | 用户管理 |
| 来源模块/系统 | 用户管理 |
| 认证方式 | Bearer Token（管理员令牌） |
完整请求
请求
正在加载示例…失败请求
正在加载示例…接口说明
用户列表
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| custom_field | query | object | 否 | 自定义字段 key为自定义字段名称 value为自定义字段的值 |
| type | query | string | 否 | 关键字类型 id用户 ID username姓名 phone手机号 email邮箱 company公司 |
| keywords | query | string | 否 | 关键字 搜索范围随关键字类型变化 默认搜索范围为用户 ID 姓名 邮箱 手机号 公司 |
| client_id | query | integer(int32) | 否 | 用户 ID 精确搜索 |
| page | query | integer(int32) | 否 | 页数 |
| limit | query | integer(int32) | 否 | 每页条数 |
| orderby | query | string | 否 | 排序 id reg_time host_active_num host_num credit cost_price refund_price withdraw_price |
| sort | query | string | 否 | 升降序 asc desc |
| show_sub_client | query | integer(int32) | 否 | 显示子账户 0隐藏 1显示 |
| addon_client_custom_field_[num] | query | string | 否 | 搜索用户自定义字段 num为自定义字段 ID |
成功响应
正在加载示例…失败响应 400：请求参数或业务校验失败
正在加载示例…失败响应 401：未认证或登录已失效
正在加载示例…失败响应 403：无权执行当前操作
正在加载示例…失败响应 404：接口或业务资源不存在
正在加载示例…失败响应 500：服务器内部错误
正在加载示例…响应状态
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功响应 | 内联对象 |
| 400 | Bad Request | 请求参数或业务校验失败 | 内联对象 |
| 401 | Unauthorized | 未认证或登录已失效 | 内联对象 |
| 403 | Forbidden | 无权执行当前操作 | 内联对象 |
| 404 | Not Found | 接口或业务资源不存在 | 内联对象 |
| 500 | Internal Server Error | 服务器内部错误 | 内联对象 |
响应参数
状态码 200
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 否 | — | 状态码 |
msg | string | 否 | — | 提示信息 |
data | object | 否 | — | — |
data.list | [object] | 否 | — | 用户列表 |
data.list[].id | integer(int32) | 否 | — | 用户 ID |
data.list[].username | string | 否 | — | 姓名 |
data.list[].email | string | 否 | — | 邮箱 |
data.list[].phone_code | integer(int32) | 否 | — | 国际电话区号 |
data.list[].phone | string | 否 | — | 手机号 |
data.list[].status | integer(int32) | 否 | — | 状态 0禁用 1正常 |
data.list[].reg_time | integer(int32) | 否 | — | 注册时间 |
data.list[].country | string | 否 | — | 国家 |
data.list[].address | string | 否 | — | 地址 |
data.list[].company | string | 否 | — | 公司 |
data.list[].language | string | 否 | — | 语言 |
data.list[].notes | string | 否 | — | 备注 |
data.list[].credit | string | 否 | — | 余额 |
data.list[].host_num | integer(int32) | 否 | — | 产品数量 |
data.list[].host_active_num | integer(int32) | 否 | — | 已激活产品数量 |
data.list[].custom_field | [object] | 否 | — | 自定义字段 |
data.list[].custom_field[].name | string | 否 | — | 名称 |
data.list[].custom_field[].value | string | 否 | — | 值 |
data.list[].cost_price | string | 否 | — | 消费金额 |
data.list[].certification | boolean | 否 | — | 是否实名认证 true是 false否 |
data.list[].certification_type | string | 否 | — | 实名类型 person个人 company企业 |
data.list[].client_level | string | 否 | — | 用户等级 显示字段有client_level时返回 |
data.list[].client_level_color | string | 否 | — | 用户等级颜色 显示字段有client_level时返回 |
data.list[].sale | string | 否 | — | 销售 显示字段有sale时返回 |
data.list[].oauth | [string] | 否 | — | 关联的三方登录类型 |
data.list[].mp_weixin_notice | integer(int32) | 否 | — | 微信公众号关注状态 0未关注 1已关注 |
data.list[].refund_price | string | 否 | — | 退款金额 显示字段有refund_price时返回 |
data.list[].withdraw_price | string | 否 | — | 提现金额 显示字段有withdraw_price时返回 |
data.list[].addon_client_custom_field_[num] | string | 否 | — | 用户自定义字段 显示字段有addon_client_custom_field_[num]时返回 num为数字 |
data.count | integer(int32) | 否 | — | 用户总数 |
data.total_credit | string | 否 | — | 总余额 |
data.page_total_credit | string | 否 | — | 当前页总余额 |
失败状态码 400、401、403、404、500 共用以下结构：
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 是 | — | 错误状态码 |
msg | string | 是 | — | 错误提示 |