跳到主要内容

获取部门成员列表

调用本接口，获取部门成员列表

权限说明​

「超管accessToken」和「权限组accessToken」都可以调用，「权限组accessToken」须具有通讯录权限。

请求​

请求方式：GET

**请求地址：**https://api.qingflow.com/department/:deptId/user（公有云版本）

请求地址中:deptId为需要替换的变量，根据实际获取值更新，示例如下：

GET https://api.qingflow.com/department/12345/user?fetchChild=true

其他版本请求地址：

钉钉版本：https://api.ding.qingflow.com/department/:deptId/user

专有轻流：http(s)://xxx.xx(自有域名)/openApi/department/:deptId/user

2.1 参数说明(路径参数)：​

参数必须说明
deptId是部门id，可通过文档接口获取

2.2 参数说明(查询参数)：​

参数必须类型说明
fetchChild是boolean是否递归获取子部门成员，true or false

2.3 请求头（Header）​

参数必须说明
accessToken是调用接口凭证。获取方法请查看“文档”

返回​

3.1 返回体​

参数必含类型说明
errCode是int错误码，非0表示失败
errMsg是string错误描述
questionRelations关联的设置，这里没用
result是object返回结果
leaderIds是
userList是array
userIdstring用户的userId
namestring用户名
areaCodestring
mobileNumstring手机号
emailstring邮箱
headImgstring头像
departmentarray同步部门id列表
rolearray同步角色id列表
customRolearray自建角色id列表（仅企业微信/钉钉/飞书等特殊工作区适用）
customDepartmentarray自建部门id列表（仅企业微信/钉钉/飞书等特殊工作区适用）
beingDisabledboolean是否禁用成员
beingActiveboolean用户的激活状态

3.2 返回体示例​

{
    "errCode": 0,
    "errMsg": null,
    "questionRelations": [],
    "result": {
        "leaderIds": [],
        "userList": [
            {
                "areaCode": "86",
                "beingActive": true,
                "beingDisabled": false,
                "customDepartment": [],
                "customRole": [],
                "department": [
                    135379
                ],
                "email": "caoxue@exiao.tech",
                "headImg": "https://file.qingflow.com/uploads/file/16acef5d-b66863a7.jpg",
                "mobileNum": "13124679852",
                "name": "snow",
                "optionId": 843642,
                "role": [
                    223984
                ],
                "userId": "843642"
            },
            {
                "areaCode": "86",
                "beingActive": true,
                "beingDisabled": false,
                "customDepartment": [],
                "customRole": [],
                "department": [
                    135379
                ],
                "email": "liao@exiao.tech",
                "headImg": "https://file.qingflow.com/uploads/file/55245bf6-a88e09668.jpeg",
                "mobileNum": "17853738492",
                "name": "刘",
                "optionId": 836781,
                "role": [
                    267688,
                    268480
                ],
                "userId": "836781"
            }
        ]
    }
}