查询企业用户信息

调用该接口获取通讯录中某一用户的信息,包括用户 ID、名称、状态以及所属部门等信息。

注意事项

默认只返回处于正常状态的用户数据。

请求

基本
请求方式GET
请求地址/openapi/v3/contacts/users/:union_id

请求头

名称类型必填描述
Authorizationstring值格式Bearer {{access_token}}

调用 API 时,需要通过访问凭证(access_token)进行身份鉴权,不同类型的访问凭证可获取的数据范围不同,参考 获取访问凭证

支持鉴权类型:
应用级token:以应用身份调用 API,校验应用的数据访问范围。参考 获取企业内部应用access_token
用户级token:以登录用户身份调用 API,校验用户的可见数据范围。参考 获取登录用户access_token
Content-Typestring固定值:application/json; charset=utf-8

路径参数

名称类型必填描述
union_idstringOneID企业用户id

请求参数

名称类型必填描述
ignore_statusbool是否忽略状态,默认不忽略。
True:不论用户处于什么状态,均会返回
False:只返回处于正常状态的用户数据

响应

响应体

1{
2 "code": 0, // 错误码,非0表示失败
3 "msg": "success",
4 "data": {
5 "user": {
6 "union_id": "eu officia nostrud",
7 "name": "aute id dolore incididunt", // 姓名
8 "join_time": "2023-09-01", // 入职时间
9 "avatar": "头像",
10 "status": "Enable", // 状态
11 "alias_id": "", // 自定义ID
12 "employee_number": "458152", // 工号
13 "position": "架构师", // 职位
14 "departments": [{
15 "department_id": "2312312",
16 "department_name": "dept",
17 "department_parent_id": "parent",
18 "is_main_department": true
19 }]
20 }
21 }
22}