# 获取部门直属用户列表

根据部门ID,获取部门下用户列表。

注意事项:

  • 使用 user_access_token 情况下根据个人组织架构的通讯录可见范围进行权限过滤,返回个人组织架构通讯录范围
  • 使用tenant_access_token,会根据应用通讯录的范围进行权限过滤

# 请求

基本
HTTP URL https://hi-gw.weizhipin.com/open-apis/contact/v2/users/find_by_department
HTTP Method GET
支持的应用类型 自建应用
商店应用
权限要求
开启任一权限即可
以应用身份读取通讯录
字段权限要求 该接口返回体中存在下列敏感字段,仅当开启对应的权限后才会返回;如果无需获取这些字段,则不建议申请
获取用户基本信息
获取用户 user_id
获取用户邮箱
获取用户性别
获取用户手机号
获取用户雇佣信息
获取用户组织架构信息

# 请求头

名称 类型 必填 描述
Authorization string tenant_access_token

user_access_token
值格式:"Bearer access_token"
示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560"

# 查询参数

名称 类型 描述
user_id_type string 用户 ID 类型示例值:"open_id"
可选值有:
open_id:用户的 open id
union_id:用户的 union id
user_id:用户的 user id
默认值:open_id
当值为 user_id,字段权限要求:
获取用户 user ID
department_id string 填写该字段表示获取该部门下用户,必填

# 响应

# 响应体

名称 类型 描述
code int 错误码,非 0 表示失败
msg string 错误描述
data - -
 ∟pageToken string 下一页的分页标记
 ∟hasMore boolean 是否还有下一页
 ∟items - -
  ∟open_id string 开放平台唯一Id,标识一个用户在某个应用中的身份
  ∟union_id string 标识一个用户在某个应用开发商下的身份
  ∟user_id string 租户内用户的唯一标识,用户的user_id
字段权限要求
获取用户 user_id(仅自建应用)
  ∟ name string 用户名
字段权限要求(满足任一)
获取用户基本信息
  ∟ nickname string 别名
字段权限要求(满足任一)
获取用户基本信息
  ∟ email string 邮箱,注意非 +86 手机号成员必须同时添加邮箱
字段权限要求
获取用户邮箱信息
  ∟ mobile string 手机号,在本企业内不可重复;未认证企业仅支持添加中国大陆手机号,注意国际电话区号前缀中必须包含加号 +
字段权限要求
获取用户手机号
  ∟ gender int 性别
可选值有
* 0:保密
* 1:男
* 2:女
字段权限要求(满足任一)
获取用户性别
  ∟ avatar_key string 用户头像信息
字段权限要求(满足任一)
获取用户基本信息
  ∟ status user_status 用户状态
字段权限要求(满足任一)
获取用户雇佣信息
   ∟is_resigned boolean 是否离职
   ∟is_activated boolean 是否激活
  ∟department_ids string[] 用户所属部门的ID列表,一个用户可属于多个部门,主部门在第一个。
字段权限要求(满足任一)
获取部门基础信息
  ∟ leader_user_id string 用户的直接主管的用户ID,
字段权限要求(满足任一)
获取用户 user_id
  ∟lateral_user_ids string[] 次级汇报人Id
  ∟join_time string 入职时间
  ∟leave_time string 离职时间
  ∟participatework_time string 参加工作时间
  ∟employee_type string 员工类型
可选值有
* REGULAR:正式
* PROBATIONARY:试用
  ∟ report_user_id string 汇报人userId。
字段权限要求(满足任一)
获取用户 user_id
  ∟ employee_no string 工号
字段权限要求(满足任一)
获取用户组织架构信息
  ∟ job_title string 职务
字段权限要求(满足任一)
获取用户组织架构信息
  ∟work_station string 工位
  ∟custom_attr custom_attr[] 自定义字段
   ∟field_name string 字段名称
   ∟field_value string 字段值
   ∟type string 字段类型
可选值有
* TEXT:文本
* WEB:网页
* DOWN_SINGLE:下拉单选
* DOWN_MULTIPLE:下拉多选
* DATE:日期
* DATE_INTER:日期区间
* STAFF_SINGLE:人员单选
* STAFF_MULTIPLE:人员多选
* DEPT_SINGLE:部门单选
* DEPT_MULTIPLE:部门多选

# 响应体示例

{
    "code": 0,
    "success": true,
    "data": {
        "hasMore": true,
        "pageToken": "12a764bdadbd106b1Q~~",
        "items": [
            {
                "unionId": "on_13faf531b39d56a6cea442684a333f28",
                "userId": "12345",
                "openId": "ou_467c5788802773fc826c5a015015106d",
                "name": "曾林泓",
                "enName": null,
                "nickname": "",
                "email": "zenglinhong@kanzhun.com",
                "mobile": "13245678909",
                "mobileVisible": false,
                "gender": 1,
                "avatarKey": "https://bosshi-admin-qa.weizhipin.com/api/common/media/download/90a6083aed91f5a1hRpdTay5rPSAevDdJHl6ZvGUyxQdI1KW3RPmpCH61_GMkMGzf0mXM7fEh7EcS8MlI20cxi75XTyG9sGZf4K4yOm_f63yNrun.png?avatarType=1",
                "avatar": null,
                "status": {
                    "is_resigned": false,
                    "is_activated": true
                },
                "departmentIds": [
                    "1234"
                ],
                "leaderUserId": "ou_61847c84e42decef72a49b3f02523d85",
                "city": null,
                "country": null,
                "workStation": "",
                "joinTime": "2021-06-15 00:00:00",
                "employeeNo": "12345",
                "isTenantManager": null,
                "employeeType": null,
                "orders": null,
                "customAttrs": null,
                "enterpriseEmail": null,
                "jobTitle": "大厨",
                "isFrozen": null,
                "reportUserId": "ou_eebd94dce1dbaf644c97dea4bb298a5c",
                "icon": "https://bosshi-admin-qa.weizhipin.com/api/common/media/download/90a6083aed91f5a1hRpdTay5rPSAevDdJHl6ZvGUyxQdI1KW3RPmpCH61_GMkMGzf0mXM7fEh7EcS8MlI20cxi75XTyG9sGZf4K4yOm_f63yNrun.png?avatarType=1",
                "lateralUserIds": null,
                "leaveTime": null,
                "participateworkTime": "1000-01-01 00:00:00",
                "realUserIdCode": "9fbd9091f81ee1421UUeDPzp"
            }
        ]
    },
    "msg": "操作成功",
    "traceId": "9abcaeb0-fc33-469f-9839-5116bc550790"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
最后更新于 : 11/9/2023, 8:02:07 PM