jdy
  1. department
jdy
  • 开发指南
  • app
    • 用户应用查询接口
      POST
    • 用户表单查询接口
      POST
  • formdata
    • form
      • 表单字段查询接口V5
    • data
      • 查询单条数据接口
      • 查询多条数据接口
      • 新建单条数据接口
      • 新建多条数据接口
      • 修改单条数据接口
      • 修改多条数据接口
      • 删除单条数据接口
      • 删除多条数据接口
  • file
    • 获取文件上传凭证和上传地址接口
      POST
    • 文件上传接口
      POST
  • corp
    • user
      • 获取成员信息接口
      • 添加成员接口
      • 修改成员接口
      • 删除成员接口
      • 批量删除成员接口
      • 增量导入成员接口
    • department
      • (递归)获取部门成员接口
        POST
      • (递归)获取部门列表接口
        POST
      • 创建部门接口
        POST
      • 修改部门接口
        POST
      • 删除部门接口
        POST
      • 获取集成模式部门编号接口
        POST
      • 全量导入部门接口
        POST
    • role
      • 列出角色接口
      • 创建一个自建角色
      • 更新一个自建角色
      • 删除一个自建角色
      • 列出角色下的成员
      • 为自建角色批量添加成员
      • 为自建角色批量移除成员
    • role_group
      • 列出自建角色组
      • 创建自建角色组
      • 更新自建角色组
      • 删除自建角色组
    • guest
      • 列出我连接的企业
      • 列出我连接的企业的对接人
      • 获取我连接的企业对接人的详细信息
  • workflow
    • 获取单条流程表单数据的审批意见
      POST
    • 查询流程实例信息
      POST
    • 结束流程实例
      POST
    • 流程待办查询
      POST
    • 流程待办提交
      POST
    • 流程待办回退
      POST
    • 流程待办转交
      POST
    • 查询流程日志
      POST
    • 激活流程实例
      POST
  1. department

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

POST
/v5/corp/department/user/list

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

能够(递归)获取指定部门 id 下的所有成员。支持公共模式和集成模式。
接口版本:
接口版本更新时间版本说明
v12018.12.4使用 _id 作为 id
v22019.6.21使用 dept_no 作为 id
v42022.6.30返回值新增字段 type、status、integrate_id
v52022.10.28在 v4 的基础上,接口请求频率由 5 次每秒提升至 10 次每秒;参数 dept_no 放入 body,接口路由修改为 POST corp/department/user/list
**请求地址:**https://api.jiandaoyun.com/api/v5/corp/department/user/list
**请求频率:**10 次/秒
请求方式:POST
请求参数:
参数类型是否必需说明
dept_noNumber是部门编号
has_childBoolean否是否递归获取所有成员。默认为 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
    }
  ]
}

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Body 参数application/json
dept_no
number 
部门编号
必需
has_child
boolean 
可选
是否递归获取所有成员。默认为 false,即只获取当前部门下的成员,而不获取其子部门的成员。
示例
{
    "dept_no": 1,
    "has_child": true
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.jiandaoyun.com/api/v5/corp/department/user/list' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dept_no": 1,
    "has_child": true
}'

返回响应

🟢200成功
application/json
Body
users
array [object {6}] 
必需
name
string 
昵称
可选
name 可以重复,重名成员的name相同
username
string 
用户名
可选
username 在企业内是唯一的,不同企业之间可能存在重复
departments
array[number]
用户所属的部门编号列表
可选
type
number 
部门类型
可选
0: 常规部门 2: 企业互联外部部门
status
number 
部门状态
可选
1: 使用中的部门 -1: 集成模式下同步后删除的部门
integrate_id
string 
集成模式同步部门关联 ID
必需
在集成模式下返回,且在企业互联接口(外部对接人)不返回
示例
{
    "users": [
        {
            "username": "aubrey",
            "name": "aubrey",
            "departments": [
                1
            ],
            "type": 0,
            "status": 1
        }
    ]
}
上一页
增量导入成员接口
下一页
(递归)获取部门列表接口
Built with