获取部门用户详情
POST
/topapi/v2/user/list最后修改时间:: 2 年前
责任人: 未设置
说明
调用本接口获取指定部门中的用户详细信息。
服务地址:https://oapi.dingtalk.com
权限
服务端API是以应用维度授权的,在调用接口前,确保已经为应用添加了接口权限。详情请参考权限申请。
应用类型 | 是否支持调用 | 权限申请方式 | API Explorer调试 |
---|---|---|---|
企业内部应用 | 是 | 开发者后台申请 | 调试 |
第三方企业应用 | 是 | 开发者后台申请 | 调试 |
第三方个人应用 | 否 | — | — |
请求参数
Query 参数
access_token
string
必需
调用服务端API的应用凭证。企业内部应用可通过获取企业内部应用的access_token接口获取。第三方企业应用可通过获取第三方企业应用的access_token接口获取。
示例值:
be3Fxxxx
Body 参数application/json
dept_id
number
必需
部门ID,根部门ID为1。只获取当前部门下的员工信息,不包含子部门内的员工。
cursor
number
必需
分页查询的游标,最开始传0,后续传返回参数中的next_cursor值。
size
number
分页大小。
order_field
string
可选
部门成员的排序规则,默认不传是按自定义排序(custom):entry_asc:代表按照进入部门的时间升序entry_desc:代表按照进入部门的时间降序modify_asc:代表按照部门信息修改时间升序modify_desc:代表按照部门信息修改时间降序custom:代表用户定义(未定义时按照拼音)排序
contain_access_limit
boolean
可选
是否返回访问受限的员工。
language
string
可选
通讯录语言,取值。zh_CN:中文(默认值)。en_US:英文。
示例
{
"cursor": 0,
"contain_access_limit": false,
"size": 10,
"order_field": "modify_desc",
"language": "zh_CN",
"dept_id": 10
}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
errcode
number
可选
错误码,0代表成功。
errmsg
string
返回码描述。
result
object
返回结果。
has_more
boolean
可选
是否还有更多的数据。
next_cursor
number
可选
下一次分页的游标,如果has_more为false,表示没有更多的分页数据。
list
array [object {25}]
用户信息列表。
示例
{
"errcode": 0,
"errmsg": "string",
"result": {
"has_more": true,
"next_cursor": 0,
"list": [
{
"userid": "string",
"unionid": "string",
"name": "string",
"avatar": "string",
"state_code": "string",
"mobile": "string",
"hide_mobile": true,
"telephone": "string",
"job_number": "string",
"title": "string",
"email": "string",
"org_email": "string",
"work_place": "string",
"remark": "string",
"dept_id_list": [
0
],
"dept_order": 0,
"extension": "string",
"hired_date": 0,
"active": true,
"admin": true,
"boss": true,
"leader": true,
"exclusive_account": true,
"login_id": "string",
"exclusive_account_type": "string"
}
]
}
}
最后修改时间: 2 年前