# 批量获取员工列表 本接口用于依据指定条件，批量获取符合条件的员工详情列表。 员工指飞书企业内身份为「Employee」的成员，等同于通讯录OpenAPI中的「User」 **注意事项**：注意： - 本接口支持tenant_access_token和user_access_token - 使用tenant_access_token时，数据权限遵循应用的通讯录权限范围，返回的字段数据为应用有权限的字段。可通过[获取应用通讯录权限范围配置](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/application-v6/application/contacts_range_configuration)确定应用的通讯录权限范围。 - 使用user_access_token时，默认为管理员用户，将校验管理员管理范围。当用户有多个管理员身份均可查看员工信息时，管理员管理范围取最大集。管理员权限可查看帮助中心文档： [管理员创建管理员角色及分配权限](https://www.feishu.cn/hc/zh-CN/articles/360043495213-%E7%AE%A1%E7%90%86%E5%91%98%E5%88%9B%E5%BB%BA%E7%AE%A1%E7%90%86%E5%91%98%E8%A7%92%E8%89%B2%E5%8F%8A%E5%88%86%E9%85%8D%E6%9D%83%E9%99%90#tabs0|lineguid-dU31C) ## 请求 基本 |   ---|--- HTTP URL | https://open.feishu.cn/open-apis/directory/v1/employees/filter HTTP Method | POST 接口频率限制 | [1000 次/分钟、50 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN) 支持的应用类型 | Custom App、Store App 权限要求
**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 调用 API 获取员工列表(directory:employee:list) 字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请
查看部门基础信息(directory:department.base:read)
查看部门成员与子部门计数(directory:department.count:read)
查看部门自定义字段信息(directory:department.custom_field:read)
查看部门数据来源(directory:department.data_source:read)
查看部门路径信息(directory:department.department_path:read)
查看部门自定义 ID(directory:department.external_id:read)
查看部门是否有子部门(directory:department.has_child:read)
查看部门负责人信息(directory:department.leader:read)
查看部门的名称(directory:department.name:read)
查看部门排序权重(directory:department.order_weight:read)
查看部门组织架构信息(directory:department.organization:read)
查看部门的父部门 ID(directory:department.parent_id:read)
查看部门的停启用状态(directory:department.status:read)
查看员工账号活跃状态(directory:employee.base.active_status:read)
查看员工的头像(directory:employee.base.avatar:read)
查看员工的名片页自定义背景图(directory:employee.base.background_image:read)
查看员工个人基本信息(directory:employee.base.base:read)
查看员工自定义字段值(directory:employee.base.custom_field:read)
查看员工数据来源(directory:employee.base.data_source:read)
查看员工所属部门信息(directory:employee.base.department:read)
查看员工部门路径(directory:employee.base.department_path:read)
查看员工在部门内的排序(directory:employee.base.dept_order:read)
查看员工的个性签名(directory:employee.base.description:read)
查看员工虚线上级 ID(directory:employee.base.dotted_line_leaders:read)
查看员工工作邮箱(directory:employee.base.email:read)
查看员工企业邮箱(directory:employee.base.enterprise_email:read)
查看员工的企业邮箱别名(directory:employee.base.enterprise_email_alias:read)
查看员工自定义 ID(directory:employee.base.external_id:read)
查看员工性别(directory:employee.base.gender:read)
查看员工数据驻留地(directory:employee.base.geo:read)
查看员工是否是普通管理员(directory:employee.base.is_admin:read)
查看员工是否是超级管理员(directory:employee.base.is_primary_admin:read)
查看员工离职状态(directory:employee.base.is_resigned:read)
查看员工上级信息(directory:employee.base.leader:read)
查看员工直属上级 ID(directory:employee.base.leader_id:read)
查看员工手机号(directory:employee.base.mobile:read)
查看员工的别名(directory:employee.base.name.another_name:read)
查看员工的姓名(directory:employee.base.name.name:read)
查看员工离职时间(directory:employee.base.resign_time:read)
查看员工角色信息(directory:employee.base.role:read)
查看员工状态信息(directory:employee.base.status:read)
查看员工席位信息(directory:employee.base.subscription_ids:read)
查看员工基础工作信息(directory:employee.work.base_work:read)
查看地点状态(directory:place.status:read)
查看员工的员工类型(directory:employee.work.employment_type:read)
查看员工的分机号(directory:employee.work.extension_number:read)
查看员工的工号(directory:employee.work.job_number:read)
查看员工职务信息(directory:employee.work.job_title:read)
查看员工的入职日期(directory:employee.work.join_date:read)
查看员工离职日期(directory:employee.work.resign_date:read)
查看员工离职原因(directory:employee.work.resign_reason:read)
查看员工离职备注(directory:employee.work.resign_remark:read)
查看员工离职类型(directory:employee.work.resign_type:read)
查看员工的人事状态(directory:employee.work.staff_status:read)
查看员工的工作国家/地区(directory:employee.work.work_country_or_region:read)
查看员工的工作地点(directory:employee.work.work_place:read)
查看员工的工位(directory:employee.work.work_station:read)
查看职务基础信息(directory:job_title.base:read)
查看职务状态(directory:job_title.status:read)
查看地点基础信息(directory:place.base:read)
查看工作序列的路径信息(directory:job_family.path:read)
查看企业中工作序列的状态信息(directory:job_family.status:read)
101098(directory:job_level.base:read)
101100(directory:job_level.order:read)
101099(directory:job_level.status:read)
查看员工的职级(directory:employee.work.job_level:read)
查看员工的序列(directory:employee.work.job_family:read)
查看工作序列的信息(directory:job_family.base:read)
查看员工雇佣信息(directory:employee.work.employment:read) ### 请求头 名称 | 类型 | 必填 | 描述 ---|---|---|--- Authorization | string | 是 | `tenant_access_token`
或
`user_access_token`
**值格式**："Bearer `access_token`"
**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"
[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use) Content-Type | string | 是 | **固定值**："application/json; charset=utf-8" ### 查询参数 名称 | 类型 | 必填 | 描述 ---|---|---|--- employee_id_type | string | 否 | 用户 ID 类型
**示例值**：open_id
**可选值有**：
- open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)
- union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)
- employee_id：企业内在职员工的唯一标识。支持自定义，未自定义时系统自动生成。ID支持修改。
获取employee_id的方式：
- 企业管理员在 管理后台 > 组织架构 > 成员与部门 页面，点击 成员详情，查询员工ID
- 通过 [批量获取员工列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/employee/filter) 的接口，通过手机号或邮箱查询员工ID。
**默认值**：`open_id`
**当值为 `employee_id`，字段权限要求**：
查看员工自定义 ID(directory:employee.base.external_id:read) department_id_type | string | 否 | 此次调用中使用的部门ID的类型
**示例值**：open_department_id
**可选值有**：
- department_id：用来标识租户内一个唯一的部门
- open_department_id：用来在具体某个应用中标识一个部门，同一个部门 在不同应用中的 open_department_id 相同。
**默认值**：`open_department_id` ### 请求体 名称 | 类型 | 必填 | 描述 ---|---|---|--- filter | multi_filter_condition | 是 | 查询条件[了解更多：查询条件用法](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/filter-usage) conditions | filter_condition\[\] | 是 | 比较表达式列表，内容如 base_info.mobile eq `"\"+8613000000001\""`的比较条件，多个表达式之间的关系为且。
**数据校验规则**：
- 长度范围：`0` ～ `10` field | string | 是 | 筛选条件的左值，值为字段的参数名称。可选的筛选条件有：
- base_info.mobile
- base_info.email
- base_info.departments.department_id和work_info.staff_status（需同时指定）
- work_info.job_number
**示例值**："base_info.mobile" operator | string | 是 | 比较操作符。可选值有：
- eq：等于，支持任何类型的左值
- in：属于任一
各个字段支持的操作符可能不同，具体见[了解更多：查询条件用法](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/filter-usage)
**示例值**："eq" value | string | 是 | 筛选条件的右值，为转义后的json字符串。
- eq匹配字符串，使用 `"\"str\""`
- in匹配字符串列表，使用 `"[\"str\"]"`
- eq匹配数字，使用 `"123"`
- in匹配数字列表，使用 `"[123]"`
**示例值**："`\"8619922333322\"`" required_fields | string\[\] | 是 | 需要查询的字段列表。将按照传递的字段列表返回有权限的行、列数据。不传则不会返回任何字段。[了解更多：字段枚举说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/directory-v1/field-enumeration)
**示例值**：["base_info.gender"]
**数据校验规则**：
- 长度范围：`0` ～ `100` page_request | page_condition | 是 | 分页参数 page_size | int | 否 | 本次请求条数，最小0条，最大100条
**示例值**：10 page_token | string | 否 | 顺序分页查询，不能跳页查询，支持深分页，在需要遍历全部数据的场景只能使用该方式。第一次传空字符串或者不传，后面传上一次的返回值中的page_token
**示例值**："\r" ### 请求体示例 ```json { "filter": { "conditions": [ { "field": "base_info.mobile", "operator": "eq", "value": "\"8619922333322\"" } ] }, "required_fields": [ "base_info.gender" ], "page_request": { "page_size": 10, "page_token": "" } } ``` ## 响应 ### 响应体 名称 | 类型 | 描述 ---|---|--- code | int | 错误码，非 0 表示失败 msg | string | 错误描述 data | \- | \- employees | employee_entity\[\] | 员工信息 base_info | employee_base_entity | 员工基础信息 employee_id | string | 企业内在职员工的唯一标识
`employee_id_type`为`open_id`或者`union_id`时无需权限，使用`employee_id`类型时，权限要求如下
**字段权限要求**：
查看员工自定义 ID(directory:employee.base.external_id:read) name | name | 姓名 name | i18n_text | 员工的姓名
**字段权限要求（满足任一）**：
查看员工个人基本信息(directory:employee.base.base:read)
查看员工的姓名(directory:employee.base.name.name:read) default_value | string | 默认值 i18n_value | map<string, string> | 国际化值，key为zh_cn, ja_jp, en_us, value为对应的值 another_name | string | 别名
**字段权限要求（满足任一）**：
查看员工个人基本信息(directory:employee.base.base:read)
查看员工的别名(directory:employee.base.name.another_name:read) mobile | string | 员工的手机号
**字段权限要求**：
查看员工手机号(directory:employee.base.mobile:read) email | string | 员工在工作中的邮箱
**字段权限要求**：
查看员工工作邮箱(directory:employee.base.email:read) enterprise_email | string | 员工的企业邮箱
**字段权限要求**：
查看员工企业邮箱(directory:employee.base.enterprise_email:read) gender | int | 性别
**可选值有**：
- 0：未知
- 1：男
- 2：女
- 3：其他
**字段权限要求**：
查看员工性别(directory:employee.base.gender:read) departments | department\[\] | 员工所属的部门信息。一个员工可属于多个部门，排在第一个的为主部门
**字段权限要求**：
查看员工所属部门信息(directory:employee.base.department:read) department_id | string | 部门ID
**字段权限要求（满足任一）**：
查看部门基础信息(directory:department.base:read)
查看部门自定义 ID(directory:department.external_id:read) department_count | department_count | 部门成员与子部门计数
**字段权限要求（满足任一）**：
查看部门成员与子部门计数(directory:department.count:read)
查看部门组织架构信息(directory:department.organization:read) recursive_members_count | string | 递归成员数量 direct_members_count | string | 直属成员数量 recursive_members_count_exclude_leaders | string | 递归成员数量(不含leader) recursive_departments_count | string | 递归子部门数量 direct_departments_count | string | 直属子部门数量 has_child | boolean | 是否有子部门
**字段权限要求（满足任一）**：
查看部门是否有子部门(directory:department.has_child:read)
查看部门组织架构信息(directory:department.organization:read) leaders | department_leader\[\] | 部门负责人
**字段权限要求**：
查看部门负责人信息(directory:department.leader:read) leader_type | int | 部门负责人类型
**可选值有**：
- 1：主
- 2：副 leader_id | string | 部门负责人ID parent_department_id | string | 父部门ID
**字段权限要求（满足任一）**：
查看部门组织架构信息(directory:department.organization:read)
查看部门的父部门 ID(directory:department.parent_id:read) name | i18n_text | 部门名称
**字段权限要求（满足任一）**：
查看部门基础信息(directory:department.base:read)
查看部门的名称(directory:department.name:read) default_value | string | 默认值 i18n_value | map<string, string> | 国际化值，key为zh_cn, ja_jp, en_us, value为对应的值 enabled_status | boolean | 是否启用
**字段权限要求**：
查看部门的停启用状态(directory:department.status:read) order_weight | string | 部门排序权重
**字段权限要求（满足任一）**：
查看部门排序权重(directory:department.order_weight:read)
查看部门组织架构信息(directory:department.organization:read) custom_field_values | custom_field_value\[\] | 自定义字段
**字段权限要求**：
查看部门自定义字段信息(directory:department.custom_field:read) field_type | string | 自定义字段类型
**可选值有**：
- 1：多行文本
- 2：网页链接
- 3：枚举选项
- 4：人员
- 9：电话
- 10：多选枚举类型(目前仅支持文本类型)
- 11：人员列表 text_value | i18n_text | 文本字段值 default_value | string | 默认值 i18n_value | map<string, string> | 国际化值，key为zh_cn, ja_jp, en_us, value为对应的值 url_value | url_value | 网页链接字段值 link_text | i18n_text | 网页标题 default_value | string | 默认值 i18n_value | map<string, string> | 国际化值，key为zh_cn, ja_jp, en_us, value为对应的值 url | string | 移动端网页链接 pcurl | string | 桌面端网页链接 enum_value | enum_value | 枚举 enum_ids | string\[\] | 选项结果ID enum_type | string | 选项类型
**可选值有**：
- 1：文本
- 2：图片 user_values | user_value\[\] | 人员字段值 ids | string\[\] | 人员ID phone_value | phone_value | 电话字段值 phone_number | string | 电话号 extension_number | string | 分机号 field_key | string | 自定义字段key department_path_infos | department_base_info\[\] | 部门路径信息。排列顺序为根部门到末级部门。
**字段权限要求**：
查看部门路径信息(directory:department.department_path:read) department_id | string | 部门ID department_name | i18n_text | 部门名称 default_value | string | 默认值 i18n_value | map<string, string> | 国际化值，key为zh_cn, ja_jp, en_us, value为对应的值 data_source | int | 数据来源
**可选值有**：
- 1：管理后台
- 2：人事企业版
- 3：SCIM
**字段权限要求（满足任一）**：
查看部门基础信息(directory:department.base:read)
查看部门数据来源(directory:department.data_source:read) employee_order_in_departments | user_department_sort_info\[\] | 用户在部门内的排序信息， 第一个部门为主部门
**字段权限要求（满足任一）**：
查看员工所属部门信息(directory:employee.base.department:read)
查看员工在部门内的排序(directory:employee.base.dept_order:read) department_id | string | 部门id order_weight_in_deparment | string | 用户在部门内的排序权重 order_weight_among_deparments | string | 用户多个部门间的排序权重 description | string | 个人签名
**字段权限要求（满足任一）**：
查看员工个人基本信息(directory:employee.base.base:read)
查看员工的个性签名(directory:employee.base.description:read) active_status | int | 用户活跃状态
**可选值有**：
- 1：未激活
- 2：激活
- 3：冻结
- 4：主动退出
- 5：未加入
**字段权限要求（满足任一）**：
查看员工账号活跃状态(directory:employee.base.active_status:read)
查看员工状态信息(directory:employee.base.status:read) is_resigned | boolean | 是否离职
**字段权限要求（满足任一）**：
查看员工离职状态(directory:employee.base.is_resigned:read)
查看员工状态信息(directory:employee.base.status:read) leader_id | string | 直属上级ID
**字段权限要求（满足任一）**：
查看员工上级信息(directory:employee.base.leader:read)
查看员工直属上级 ID(directory:employee.base.leader_id:read) dotted_line_leader_ids | string\[\] | 虚线上级ID
**字段权限要求（满足任一）**：
查看员工虚线上级 ID(directory:employee.base.dotted_line_leaders:read)
查看员工上级信息(directory:employee.base.leader:read) is_primary_admin | boolean | 是否租户超级管理员
**字段权限要求（满足任一）**：
查看员工是否是超级管理员(directory:employee.base.is_primary_admin:read)
查看员工角色信息(directory:employee.base.role:read) enterprise_email_aliases | string\[\] | 员工的企业邮箱别名。当成员希望针对不同人使用不同的邮箱地址进行邮件往来时，可为其企业邮箱添加别名。添加后，成员可使用别名发送邮件，也可接受发送至别名的邮件
**字段权限要求（满足任一）**：
查看员工企业邮箱(directory:employee.base.enterprise_email:read)
查看员工的企业邮箱别名(directory:employee.base.enterprise_email_alias:read) custom_field_values | custom_field_value\[\] | 自定义字段值
**字段权限要求**：
查看员工自定义字段值(directory:employee.base.custom_field:read) field_type | string | 自定义字段类型
**可选值有**：
- 1：多行文本
- 2：网页链接
- 3：枚举选项
- 4：人员
- 9：电话
- 10：多选枚举类型(目前仅支持文本类型)
- 11：人员列表 text_value | i18n_text | 文本字段值 default_value | string | 默认值 i18n_value | map<string, string> | 国际化值，key为zh_cn, ja_jp, en_us, value为对应的值 url_value | url_value | 网页链接字段值 link_text | i18n_text | 网页标题 default_value | string | 默认值 i18n_value | map<string, string> | 国际化值，key为zh_cn, ja_jp, en_us, value为对应的值 url | string | 移动端网页链接 pcurl | string | 桌面端网页链接 enum_value | enum_value | 枚举 enum_ids | string\[\] | 选项结果ID enum_type | string | 选项类型
**可选值有**：
- 1：文本
- 2：图片 user_values | user_value\[\] | 人员字段值 ids | string\[\] | 人员ID phone_value | phone_value | 电话字段值 phone_number | string | 电话号 extension_number | string | 分机号 field_key | string | 自定义字段key department_path_infos | department_base_info\[\]\[\] | 全部直属部门对应的全路径。排列顺序为根部门到末级部门
对应结构
``` json
[
/*所属部门A相关部门路径*/
[
{/*根部门*/},
{/*A的父部门*/},
{
"department_id": "abcdefg",
"i18n_text": {
"default_value": "A",
"i18n_value": {
"zh_cn": "A cn name",
"en_us": "A en name"
}
}
}
]
]
```
**字段权限要求**：
查看员工部门路径(directory:employee.base.department_path:read) resign_time | string | 离职时间。离职操作的时间，系统自动生成，无法写入。日期格式：YYYY-MM-DD
**字段权限要求**：
查看员工离职时间(directory:employee.base.resign_time:read) avatar | image_link | 员工的头像url
**字段权限要求（满足任一）**：
查看员工的头像(directory:employee.base.avatar:read)
查看员工个人基本信息(directory:employee.base.base:read) avatar_72 | string | 72*72像素头像链接 avatar_240 | string | 240*240像素头像链接 avatar_640 | string | 640*640像素头像链接 avatar_origin | string | 原始头像链接 background_image | string | 自定义背景图 url
**字段权限要求（满足任一）**：
查看员工的名片页自定义背景图(directory:employee.base.background_image:read)
查看员工个人基本信息(directory:employee.base.base:read) is_admin | boolean | 是否租户普通管理员
**字段权限要求（满足任一）**：
查看员工是否是普通管理员(directory:employee.base.is_admin:read)
查看员工角色信息(directory:employee.base.role:read) data_source | int | 数据来源
**可选值有**：
- 1：管理后台
- 2：人事企业版
- 3：SCIM
**字段权限要求（满足任一）**：
查看员工个人基本信息(directory:employee.base.base:read)
查看员工数据来源(directory:employee.base.data_source:read) geo_name | string | 员工数据驻留地
**字段权限要求（满足任一）**：
查看员工个人基本信息(directory:employee.base.base:read)
查看员工数据驻留地(directory:employee.base.geo:read) subscription_ids | string\[\] | 分配给员工的席位ID列表。
**字段权限要求（满足任一）**：
查看员工个人基本信息(directory:employee.base.base:read)
查看员工席位信息(directory:employee.base.subscription_ids:read) work_info | employee_work_entity | 员工工作信息 work_country_or_region | string | 工作地国家/地区 [如何查询国家/地区的编码含义](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/mdm-v3/batch_country_region/get)
**字段权限要求（满足任一）**：
查看员工基础工作信息(directory:employee.work.base_work:read)
查看员工的工作国家/地区(directory:employee.work.work_country_or_region:read) work_place | place | 工作地点
**字段权限要求（满足任一）**：
查看员工基础工作信息(directory:employee.work.base_work:read)
查看员工的工作地点(directory:employee.work.work_place:read) place_id | string | ID，不存在时默认返回"0" place_name | i18n_text | 工作地点名称
**字段权限要求**：
查看地点基础信息(directory:place.base:read) default_value | string | 默认值 i18n_value | map<string, string> | 国际化值，key为zh_cn, ja_jp, en_us, value为对应的值 is_enabled | boolean | 是否启用
**字段权限要求**：
查看地点状态(directory:place.status:read) description | i18n_text | 描述
**字段权限要求**：
查看地点基础信息(directory:place.base:read) default_value | string | 默认值 i18n_value | map<string, string> | 国际化值，key为zh_cn, ja_jp, en_us, value为对应的值 work_station | i18n_text | 工位
**字段权限要求（满足任一）**：
查看员工基础工作信息(directory:employee.work.base_work:read)
查看员工的工位(directory:employee.work.work_station:read) default_value | string | 默认值 i18n_value | map<string, string> | 国际化值，key为zh_cn, ja_jp, en_us, value为对应的值 job_number | string | 工号
**字段权限要求（满足任一）**：
查看员工基础工作信息(directory:employee.work.base_work:read)
查看员工的工号(directory:employee.work.job_number:read) extension_number | string | 分机号
**字段权限要求（满足任一）**：
查看员工基础工作信息(directory:employee.work.base_work:read)
查看员工的分机号(directory:employee.work.extension_number:read) join_date | string | 入职日期。如“2007-03-20”
**字段权限要求（满足任一）**：
查看员工的入职日期(directory:employee.work.join_date:read)
查看员工雇佣信息(directory:employee.work.employment:read) employment_type | int | 员工类型
**字段权限要求（满足任一）**：
查看员工的员工类型(directory:employee.work.employment_type:read)
查看员工雇佣信息(directory:employee.work.employment:read) staff_status | int | 员工人事状态
**可选值有**：
- 1：在职
- 2：离职
- 3：待入职
- 4：取消入职
- 5：待离职
**字段权限要求（满足任一）**：
查看员工的人事状态(directory:employee.work.staff_status:read)
查看员工雇佣信息(directory:employee.work.employment:read) job_title | job_title | 职务
**字段权限要求**：
查看员工职务信息(directory:employee.work.job_title:read) job_title_id | string | ID，不存在时默认返回"0" job_title_name | i18n_text | 职务名称
**字段权限要求**：
查看职务基础信息(directory:job_title.base:read) default_value | string | 默认值 i18n_value | map<string, string> | 国际化值，key为zh_cn, ja_jp, en_us, value为对应的值 is_enabled | boolean | 是否启用
**字段权限要求**：
查看职务状态(directory:job_title.status:read) description | i18n_text | 描述
**字段权限要求**：
查看职务基础信息(directory:job_title.base:read) default_value | string | 默认值 i18n_value | map<string, string> | 国际化值，key为zh_cn, ja_jp, en_us, value为对应的值 job_level | job_level | 职级
**字段权限要求**：
查看员工的职级(directory:employee.work.job_level:read) job_level_id | string | ID job_level_name | i18n_text | i18n文本
**字段权限要求**：
101098(directory:job_level.base:read) default_value | string | 默认值 i18n_value | map<string, string> | 国际化值，key为zh_cn, ja_jp, en_us, value为对应的值 is_enabled | boolean | 是否启用
**字段权限要求**：
101099(directory:job_level.status:read) is_deleted | boolean | 是否删除
**字段权限要求**：
101099(directory:job_level.status:read) order | string | 排序, 小的在前面
**字段权限要求**：
101100(directory:job_level.order:read) description | i18n_text | i18n文本
**字段权限要求**：
101098(directory:job_level.base:read) default_value | string | 默认值 i18n_value | map<string, string> | 国际化值，key为zh_cn, ja_jp, en_us, value为对应的值 job_family | job_family | 序列
**字段权限要求**：
查看员工的序列(directory:employee.work.job_family:read) job_family_id | string | 序列ID job_family_name | i18n_text | i18n文本
**字段权限要求**：
查看工作序列的信息(directory:job_family.base:read) default_value | string | 默认值 i18n_value | map<string, string> | 国际化值，key为zh_cn, ja_jp, en_us, value为对应的值 is_enabled | boolean | 是否启用
**字段权限要求**：
查看企业中工作序列的状态信息(directory:job_family.status:read) parent_job_family_id | string | 上级序列
**字段权限要求**：
查看工作序列的路径信息(directory:job_family.path:read) description | i18n_text | i18n文本
**字段权限要求**：
查看工作序列的信息(directory:job_family.base:read) default_value | string | 默认值 i18n_value | map<string, string> | 国际化值，key为zh_cn, ja_jp, en_us, value为对应的值 resign_date | string | 离职日期 2007-03-20
**字段权限要求（满足任一）**：
查看员工离职日期(directory:employee.work.resign_date:read)
查看员工雇佣信息(directory:employee.work.employment:read) resign_reason | string | 离职原因
**示例值**："1"
**可选值有**：
- 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：其他（其他）
**字段权限要求（满足任一）**：
查看员工离职原因(directory:employee.work.resign_reason:read)
查看员工雇佣信息(directory:employee.work.employment:read) resign_remark | string | 离职备注
**字段权限要求（满足任一）**：
查看员工离职备注(directory:employee.work.resign_remark:read)
查看员工雇佣信息(directory:employee.work.employment:read) resign_type | string | 离职类型
**示例值**："1"
**可选值有**：
- 1：主动
- 2：被动
- 3：其他
**字段权限要求（满足任一）**：
查看员工离职类型(directory:employee.work.resign_type:read)
查看员工雇佣信息(directory:employee.work.employment:read) page_response | page_response | 分页结果 has_more | boolean | 是否还有后续结果，如果has_more为true，代表还有数据没有完全返回，需要使用响应结果中的page_token，并再次请求才能取得剩下的数据。 page_token | string | 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token abnormals | abnormal_record\[\] | 异常信息 id | string | 异常ID row_error | int | 行级异常
**可选值有**：
- 0：成功
- 1000：没权限 field_errors | map<string, int> | 列级异常，key为字段名,value为下列枚举
**可选值有**：
- 1000：无权限
- 2000：服务异常
- 2002：用户不存在
- 2003：字段不存在 ### 响应体示例 ```json { "code": 0, "msg": "success", "data": { "employees": [ { "base_info": { "employee_id": "sddasdeqwe", "name": { "name": { "default_value": "张三", "i18n_value": { "zh_cn": "张三" } }, "another_name": "张小明" }, "mobile": "+8613011111111", "email": "zhangsan@company.com", "enterprise_email": "zhangsan@company.com", "gender": 1, "departments": [ { "department_id": "h12921", "department_count": { "recursive_members_count": "100", "direct_members_count": "100", "recursive_members_count_exclude_leaders": "100", "recursive_departments_count": "100", "direct_departments_count": "100" }, "has_child": true, "leaders": [ { "leader_type": "1", "leader_id": "u273y71" } ], "hrbps": [ "eefasdqw" ], "parent_department_id": "h12921", "name": { "default_value": "张三", "i18n_value": { "zh_cn": "张三" } }, "order_weight": "100", "custom_field_values": [ { "field_key": "C-1000001", "field_type": "1", "text_value": { "default_value": "张三", "i18n_value": { "zh_cn": "张三" } }, "url_value": { "link_text": { "default_value": "张三", "i18n_value": { "zh_cn": "张三" } }, "url": "https://m.bytedance.com/afnasjfna", "pcurl": "http://www.fs.cn" }, "enum_value": { "enum_ids": [ "1" ], "enum_name": 1, "enum_type": "1" }, "user_values": [ { "ids": [ "1" ], "user_type": "1" } ] } ], "department_path_infos": [ { "department_id": "1", "department_name": { "default_value": "张三", "i18n_value": { "zh_cn": "张三" } } } ], "data_source": 1 } ], "employee_order_in_departments": [ { "department_id": "h12921", "order_weight_in_deparment": "100", "order_weight_among_deparments": "100" } ], "description": "新成员请多关照", "active_status": 1, "is_resigned": true, "leader_id": "uyg77nx", "dotted_line_leader_ids": [ "asdasdqwe" ], "is_primary_admin": true, "enterprise_email_aliases": [ "saqwe@163.com" ], "custom_field_values": [ { "field_key": "C-1000001", "field_type": "1", "text_value": { "default_value": "张三", "i18n_value": { "zh_cn": "张三" } }, "url_value": { "link_text": { "default_value": "张三", "i18n_value": { "zh_cn": "张三" } }, "url": "https://m.bytedance.com/afnasjfna", "pcurl": "http://www.fs.cn" }, "enum_value": { "enum_ids": [ "1" ], "enum_name": "选项结果名称", "enum_type": "1" }, "user_values": [ { "ids": [ "1" ], "user_type": "1" } ] } ], "department_path_infos": [ [ { "department_id": "1", "department_name": { "default_value": "张三", "i18n_value": { "zh_cn": "张三" } } } ] ], "resign_time": "2023-10-01", "avatar": { "avatar_72": "http://qwed.com", "avatar_240": "http://wssd.com", "avatar_640": "http://wssd.com", "avatar_origin": "https:inernal-api/image" }, "background_image": "http://sadui.com", "is_admin": true, "data_source": 1, "geo_name": "china", "subscription_ids": [ "458694723562" ] }, "work_info": { "work_country_or_region": "MDCT00000012", "work_place": { "place_id": "place100", "place_name": { "default_value": "张三", "i18n_value": { "zh_cn": "张三" } }, "is_enabled": true, "description": { "default_value": "张三", "i18n_value": { "zh_cn": "张三" } } }, "work_station": { "default_value": "张三", "i18n_value": { "zh_cn": "张三" } }, "job_number": "2845435", "extension_number": "2845435", "join_date": "2007-03-20", "employment_type": 1, "staff_status": 1, "positions": [ { "position_code": "PO18890", "position_name": "总经理", "leader_id": "2e1cf73b", "leader_position_code": "e71b94gb", "is_main_position": true, "department_id": "D100" } ], "job_title": { "job_title_id": "od-4e6ac4d14bcd5071a37a39de902c7141", "job_title_name": { "default_value": "张三", "i18n_value": { "zh_cn": "张三" } }, "is_enabled": true, "description": { "default_value": "张三", "i18n_value": { "zh_cn": "张三" } } }, "job_family": { "description": { "default_value": "" }, "is_enabled": true, "job_family_id": "5rbknygz18kv2ge", "job_family_name": { "default_value": "QAcese1", "i18n_value": { "en_us": "cese1", "ja_jp": "cese土豆1", "zh_cn": "测试1" } }, "parent_job_family_id": "0" } } } ], "page_response": { "has_more": true, "page_token": "sdefsd" }, "abnormals": [ { "row_error": 0, "field_errors": { "base_info.mobile": "1000" }, "id": "eedasfwe" } ] } } ``` ### 错误码 HTTP状态码 | 错误码 | 描述 | 排查建议 ---|---|---|--- 400 | 2220001 | param is invalid | 无效的请求参数，请修改参数 400 | 2221004 | invalid page token | 无效的token，请检查page_token是否正确或重新获取有效token。 400 | 2221005 | no page request | 无页面请求参数，请传入有效的page_request参数（如page_token或page_size）。 400 | 2220009 | Filter field is invalid | filter中的field无效，请修改filter 400 | 2220010 | Exceeded the limit size | 分页大小超过限制，请修改分页大小 400 | 2220012 | The field is not support filter | filter中的field不支持过滤，请修改filter 400 | 2220013 | The field does not support the operator | filter中的field不支持该操作符，请修改filter 400 | 2220014 | Invalid field value | filter中的value无效，请修改filter