获取部门直属用户列表

调用该接口查询指定部门的直属用户信息,包括用户 ID、名称、加入时间、头像及状态等信息。

注意事项

  • 默认只返回处于正常状态的用户数据;
  • 分页大小默认值为10,上限为2000;
  • ignore_status参数默认不忽略状态(即仅返回正常状态用户);
  • 支持分页查询,通过page_token获取后续页数据。

请求

基本
请求方式GET
请求地址/openapi/v3/contacts/departments/:department_id/direct_users

请求头

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

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

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

路径参数

名称类型必填描述
department_idstring部门id

请求参数(查询参数)

名称类型必填描述
page_sizeint分页大小,默认值10,上限2000
page_tokenstring分页token,默认查询第一页;后续页需传入上一页返回的page_token
ignore_statusbool是否忽略状态,默认False(不忽略,仅返回正常状态用户)
True:不论用户状态均返回
False:仅返回正常状态用户

响应

响应体

1{
2 "code": 0, // 错误码,非0表示失败
3 "msg": "success", // 错误信息,成功时为"success"
4 "data": {
5 "has_more": true, // 是否还有更多数据(true表示有下一页)
6 "page_token": "xxx", // 下一页的分页token(若有更多数据时返回)
7 "users": [ // 部门直属用户列表
8 {
9 "union_id": "eu officia nostrud", // 用户OneID企业用户id
10 "name": "aute id dolore incididunt", // 用户名
11 "join_time": "aute reprehenderit occaecat labore", // 加入时间
12 "avatar": "头像", // 用户头像URL
13 "status": "" // 用户状态(正常状态返回具体值)
14 }
15 ]
16 }
17}