(递归)获取部门成员接口调试

1. 简介

1.1 接口简介

能够(递归)获取指定部门 id 下的所有成员。支持公共模式和集成模式。

1.2 接口版本

接口版本

更新时间

版本说明

v1

2018.12.4

使用 _id 作为 id

v2

2019.6.21

使用 dept_no 作为 id

v4

2022.6.30

返回值新增字段 type、status、integrate_id

v5

2022.10.28

在 v4 的基础上,接口请求频率由 5 次每秒提升至 10 次每秒;

参数 dept_no 放入 body,接口路由修改为 POST corp/department/user/list

2. 接口调用

能够(递归)获取指定部门 id 下的所有成员。支持公共模式和集成模式。

请求地址:https://api.jiandaoyun.com/api/v5/corp/department/user/list

请求频率:10 次/秒

请求方式POST

请求参数:

参数

类型

是否必需

说明

dept_no

Number

部门编号

has_child

Boolean

是否递归获取所有成员。默认为 false,即只获取当前部门下的成员,而不获取其子部门的成员。

请求示例:

{
   "dept_no":1,
  "has_child": true
}

响应内容:

参数

含义

users

当前指定部门下的成员列表

单个成员的返回数据结构:

参数

含义

备注

name

昵称

name 可以重复,重名成员的name相同

username

用户名

username 在企业内是唯一的,不同企业之间可能存在重复

departments

用户所属的部门编号列表

type

部门类型

  • 0: 常规部门
  • 2: 企业互联外部部门

status

部门状态

  • 1: 使用中的部门
  • -1: 集成模式下同步后删除的部门

integrate_id

集成模式同步部门关联 ID

仅在集成模式下返回,且在企业互联接口(外部对接人)不返回

响应示例:

{
  "users": [
    {
      "username": "aubrey",
      "name": "aubrey",
      "departments": [1],
      "type": 0,
      "status": 1
    }
  ]
}

文档内容是否对您有帮助?
有帮助
没帮助没帮助
如需获取即时帮助,请联系技术支持
咨询
扫码领取100+零代码资料简道云官方微信号400-111-0890
图标在线咨询
立即体验