获取组织机构下的用户列表

接口描述:

获取指定组织机构下的用户列表

接口地址:

请求方式:

  • GET

请求参数:

参数名称 参数说明 请求类型 是否必须 数据类型 schema
accessToken 接口访问凭证 query true string
orgId 组织机构ID query true integer(int64)
lastSequence 上一次去数据后台返回给客户的Seq,默认为0 query false integer(int64)
limit 期望获取的数据量,0 < limit <= 1000,默认为1000 query false integer(int64)

响应状态

状态码 说明 schema
200 OK ApiRestResponse«List«OrgTreeUserVO»»

其他状态码参见:全局状态码

响应示例:

正确时返回:

{
    "code": 0,
    "data": [
        {
            "userId": 0,
            "nickname": "",
            "account": "",
            "avatar": "",
            "gender": 0,
            "lastSequence": 0
        }
    ],
    "message": "",
    "status": ""
}

错误时返回:

{
    "code": 500,
    "data": {},
    "message": "成功或异常消息",
    "status": "fail"
}

响应参数:

参数名称 参数说明 类型 schema
code 成功或异常编码 integer(int32) integer(int32)
data 成功或异常数据 array AppVO
message 成功或异常消息 string
status 旧接口成功、失败或异常辅助判断标记:success、fail、error,可用值:success,fail,error string
Schema 属性:

OrgTreeUserVO

参数名称 参数说明 类型 schema
userId 用户id integer(int64)
nickname 用户别名(昵称) string
account 登录账户 string
avatar 用户头像:图片路径或图标样式 string
gender 性别:(1:男,2:女) integer(int32)
lastSequence 上一次去数据后台返回给客户的Seq,初次拉取时为0 integer(int64)

调用示例:

NodeJs - Axios:

var axios = require('axios');

var config = {
  method: 'get',
  url: 'https://api_server_url/user/list?accessToken=AT-4-Q8z-8PhSfm4RYp10WUcpuWSXbjpUIRtW&orgId=1&lastSequence=0&limit=1000',
  headers: {
    'X-App-Id': '1'
  }
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Java - OkHttp 示例:

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://api_server_url/user/list?accessToken=AT-4-Q8z-8PhSfm4RYp10WUcpuWSXbjpUIRtW&orgId=1&lastSequence=0&limit=1000")
  .method("GET", null)
  .addHeader("X-App-Id", "1")
  .build();
Response response = client.newCall(request).execute();
作者:杭州天音  创建时间:2022-09-09 01:53
最后编辑:杭州天音  更新时间:2025-08-22 15:44