获取员工列表
拥有此API的权限集 |
---|
组织管理-查询 |
请求方式及url
- 请求方式:
POST
- 请求头:
Content-Type:application/json
- 接口地址:
https://api.xiaoe-tech.com/xe.ofs.user_list.get/1.0.0
- 频率限制:
10秒3000次
在线调试工具
请求
响应
请求参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
access_token | 是 | string | 专属token |
groups | 否 | string | 分组id,不传默认为根 |
page_index | 否 | int | 页码,表示第几页,从1开始;默认1 |
page_size | 否 | int | 每页条数,最大50条;默认10 |
请求示例
{
"access_token": "xe_xxxxx",
"groups": "g_appxxxxxx",
"page_index ": 1,
"page_size ": 3
}
返回参数
参数名 | 类型 | 说明 |
---|---|---|
code | int | 请求结果码 |
msg | string | 描述信息 |
data | object | 用户列表 |
用户列表 data
参数名 | 类型 | 说明 |
---|---|---|
list.user_id | string | 员工id |
list.name | string | 员工名 |
list.account | string | 账号 |
list.password | string | 密码 |
list.nickname | string | 昵称 |
list.avatar | string | 员工头像 |
list.mobile | string | 员工手机 |
list.job | string | 员工职位 |
list.email | string | 员工邮箱 |
list.gender | int | 员工性别: 0-未定义 1-男 2-女 |
list.state | int | 员工状态: 1-启用,0-停用用户所属组 |
list.state_tips | int | 0-账号正常激活,1-账号未激活,2-试用版账号拦截,3-正式版账号拦截 |
list.groups | array | 员工所属分组 |
list.auth_at | array | 授权时间 |
list.created_at | array | 导入时间 |
page.page_index | int | 页码,表示第几页,从1开始 |
page.page_size | int | 每页条数,最大50条 |
page.page_total | int | 数据总数 |
返回示例
{
"code": 0,
"msg": "success",
"data": {
"list": [
{
"user_id": "u_xxxxxx",
"name": "123",
"account": "xxxxx",
"password": "",
"nickname": "xxx",
"avatar": "xxxx",
"mobile": "xxxx",
"job": "xxx",
"email": "xxx@xx.com",
"gender": 1,
"state": 1,
"state_tips": 0,
"groups": [
"colin"
],
"auth_at": "2021-05-18 17:41:34",
"created_at": "2021-05-18 17:41:34"
},
],
"page": {
"page_index": 2,
"page_size": 1,
"page_total": 2
}
}
}