1. 花名册
睿人事OpenAPI
  • 睿人事开放接口
    • OAuth2
      • 获取token
    • 花名册
      • 查询待入职员工列表
        POST
      • 查询待入职员工详情
        POST
      • 添加待入职员工(简单数据版)
        POST
      • 添加待入职员工(完整数据通用版)
        POST
      • 待入职员工取消入职
        POST
      • 获取待入职记录元数据
        POST
      • 获取企业员工列表
        POST
      • 获取企业员工详情
        POST
      • 修改员工基本信息
        POST
      • 查询单个工作信息
        POST
      • 新增人员入职花名册
        POST
      • 新增工作信息
        POST
      • 修改指定工作信息
        POST
      • 删除指定工作信息
        POST
      • 新增离职工作信息
        POST
      • 获取花名册元数据
        POST
      • 根据证件号码获取empId
        POST
      • 员工搜索
        POST
      • 批量获取员工详情
        POST
      • 批量查询任职信息
        POST
      • 根据证件号批量查询 empId
        POST
      • 新增转正工作信息
        POST
    • 组织
      • 批量获取指定的组织
      • 获取指定的组织
      • 查询下级组织的组织数据
      • 根据部门获取部门关联的职位
      • 根据部门获取编制信息
      • 搜索组织节点
      • 获取组织节点字段定义
      • 单个创建组织
      • 停用指定的组织节点
      • 获取指定组织的历史记录列表(时间轴)
      • 在指定组织上添加新的历史记录
      • 删除指定的组织历史记录
      • 更新指定的组织历史记录
      • 设置组织关联钉钉通讯录部门
      • 取消组织关联钉钉通讯录部门
    • 成本中心
      • 查询下级成本中心数据 (一级一级给)
      • 创建成本中心
      • 获取成本中心详情
      • 更新成本中心
      • 停用成本中心
    • 生态对接
      • 使用userId置换绑定的empId
      • 使用deptId置换绑定的orgId
      • 使用empId置换绑定的userId
      • 使用orgId置换绑定的deptId
      • 同步员工的生态对接信息
    • 合同
      • 合同列表查询
    • 岗职体系
      • 查询职位详情
      • 查询职位
      • 查询序列
      • 查询职级类别
      • 查询职级
      • 查询职等
      • 查询职务
    • 兼岗
      • 查询员工兼岗信息
      • 批量获取员工兼岗记录 ID
      • 批量新增员工兼岗记录
      • 批量修改员工兼岗记录
      • 批量删除员工兼岗记录
      • 批量查询员工兼岗信息
    • 薪酬
      • 发薪活动
        • 发薪活动列表
        • 获取发薪活动详情
        • 发薪活动 - 添加算薪人员
        • 发薪活动 - 移除算薪人员
        • 获取人员范围
        • 解锁/锁定发薪活动
        • 批量创建发薪活动
        • 批量删除发薪活动
      • 薪资项
        • 获取企业薪资项
      • 薪资数据
        • 获取算薪数据
      • 薪资档案
        • 获取企业薪资档案字段
        • 获取员工适用薪资包
        • 获取薪资包详情
      • 核算组
        • 创建核算组
        • 核算组列表
      • 算薪结果
        • 算薪结果
        • 分段算薪结果
        • 提交智能校验
        • 查询智能校验结果
      • 算税
        • 生成算税人员
        • 查询算税人员生成结果
        • 批量报送算税人员
        • 查询批量报送算税人员结果
        • 更新算税人员信息
        • 查询算税人员信息
        • 提交算薪算税
        • 获得算薪算税反馈
        • 获取扣缴义务人列表
        • 获取6万减除费用人员列表
      • 薪资方案列表
    • 社保
      • 获取参保公司
      • 获取参保方案
      • 获取参保方案详情
    • datart
      • 通过仪表盘获取视图id
      • 通过仪表图表id获取数据定义&数据
    • 人员子集
      • 查询人员子集字段信息
      • 查询人员子集数据
      • 创建人员子集数据
      • 修改人员子集数据
      • 删除人员子集数据
    • 字段选项
      • 查询花名册选项类型字段中的选项值
      • 增加花名册选项类型字段中的选项
      • 启用/停用花名册选项类型字段中的选项
      • 修改花名册选项类型字段中的选项值
    • 表单平台
      • 查询表单id和名称
      • 查询表单字段信息
      • 数据查询接口
      • 新增数据
      • 更新数据
      • 删除数据
    • 审批
      • 获取审批实例ID列表
      • 获取单个审批实例详情的数据值
      • 查询审批记录(已经审批和当前审批节点)
      • 提交审批评论
      • 获取审批表单详情
      • 发起审批流程实例
    • 黑名单
      • 获取黑名单列表
    • 合同公司
      • 合同公司列表
    • 审批角色
      • 获取审批角色分组列表
      • 创建审批角色分组
      • 更新审批角色分组
      • 删除审批角色分组
      • 获取审批角色列表
      • 获取审批角色详情
      • 创建审批角色
      • 更新审批角色
      • 删除审批角色
      • 添加角色成员
      • 更新角色成员
      • 批量移除角色成员
      • 获取审批管理员列表
    • 其他模块接口
      • 绩效模块开放接口
      • 培训模块开放接口
      • 招聘模块开放接口
  • 需客户开放接口
    • 事件消息通知
  1. 花名册

获取企业员工列表

生产环境
https://app91651.eapps.dingtalkcloud.com
生产环境
https://app91651.eapps.dingtalkcloud.com
POST
https://app91651.eapps.dingtalkcloud.com
/open/api/v1/employee/list

接口文档:获取企业员工列表#

scope: employee:list

body参数#

名称类型是否必填描述
corpIdString是企业Id
orgIdsArray of String是部门ID列表(数量范围:1~20个)
employeeStatusString否员工状态(在职:working,离职quitted)
pageInteger否当前是第几页(从1开始,默认值:1)
pageSizeInteger否每页的数据量(默认值:30,最大值:100)
effectDateString否生效日期(格式:yyyy-MM-dd,未传则使用当前日期)

返回参数#

名称类型描述
codeint接口是否响应成功(200->成功)
msgString错误提示原因
dataObject返回结果

data 数据结构解释#

名称类型描述
listArray of Object员工数据列表
pageInteger当前是第几页(从1开始)
pageSizeInteger每页的数据量
totalLong总数据量

list 员工对象字段说明#

说明:员工字段分为系统字段(固定字段)和自定义字段(以 field_emp_ 开头)。下拉选择类型字段会同时返回显示值和带 _source 后缀的选项详情。

一、基础信息字段#

字段名类型描述
idString记录唯一标识
empIdString员工ID
corpIdString企业ID
nameString姓名
idNameString证件姓名
idNumberString证件号码
ageString年龄
personalEmailString个人邮箱
nativeRegionString籍贯
currentResidentialAddressString现居住地址
providentFundAccountString公积金账号

二、任职信息字段#

字段名类型描述
mainDepartmentString主部门名称
mainDepartment_sourceArray主部门选项详情
jobTitleString职位名称
jobTitle_sourceArray职位选项详情
jobLevelString职级名称
jobLevel_sourceArray职级选项详情
managerString直属上级姓名
manager_sourceArray直属上级选项详情
orgManagerString组织负责人姓名
orgManager_sourceArray组织负责人选项详情
mobileNumberString手机号码
employeeNumberString工号

三、任职状态字段#

字段名类型描述
employeeStatusString员工状态(显示值)
employeeStatus_sourceArray员工状态选项详情
employeeTypeString员工类型(显示值)
employeeType_sourceArray员工类型选项详情

四、个人信息字段#

字段名类型描述
genderString性别(显示值)
gender_sourceArray性别选项详情
idTypeString证件类型(显示值)
idType_sourceArray证件类型选项详情
maritalStatusString婚姻状况(显示值)
maritalStatus_sourceArray婚姻状况选项详情
ethnicityString民族(显示值)
ethnicity_sourceArray民族选项详情
politicalStatusString政治面貌(显示值)
politicalStatus_sourceArray政治面貌选项详情
hukouTypeString户籍类型(显示值)
hukouType_sourceArray户籍类型选项详情
hukouLocationString户籍地址(显示值,如"甘肃省/兰州市")
hukouLocation_sourceArray户籍地址选项详情(省市级联)
contractCompanyString合同公司(显示值)
contractCompany_sourceArray合同公司选项详情

五、日期字段#

字段名类型描述
dateOfBirthString出生日期(格式:yyyy-MM-dd)
onBoardingDateString入职日期(格式:yyyy-MM-dd)
probationDateString转正日期(格式:yyyy-MM-dd)
dateEnteredWorkforceString首次参加工作时间(格式:yyyy-MM-dd)
validPeriodOfIdString证件有效期(格式:yyyy-MM-dd)
lastDayOfWorkString最后工作日(离职员工,格式:yyyy-MM-dd)
effectDateString生效日期(格式:yyyy-MM-dd HH:mm:ss)
invalidDateString失效日期(格式:yyyy-MM-dd HH:mm:ss)
gmtCreateString创建时间(格式:yyyy-MM-dd HH:mm:ss)
gmtModifiedString修改时间(格式:yyyy-MM-dd HH:mm:ss)

六、工龄字段#

字段名类型描述
workSeniorityAgeString工龄(年)
companySeniorityAgeString司龄(年)

七、操作记录字段#

字段名类型描述
operateString所属操作
operateTypeString操作类型
effectVersionInteger生效版本号
deleteString删除状态

八、离职相关字段(离职员工特有)#

字段名类型描述
offBoardingTypeString离职类型(显示值)
offBoardingType_sourceArray离职类型选项详情
reasonForOffBoardingString离职原因(显示值)
reasonForOffBoarding_sourceArray离职原因选项详情

九、文件字段#

字段名类型描述
portraitSidePhotoOfIdArray身份证人像面照片
backSidePhotoOfIdArray身份证国徽面照片
offBoardingPaperworkArray离职材料/其他附件

十、审批信息字段#

字段名类型描述
approvalInfosArray审批信息列表

十一、自定义字段#

字段名模式类型描述
field_emp_stri_xxxString自定义字符串字段(根据企业配置动态返回)
field_emp_date_xxxString自定义日期字段
field_emp_numb_xxxNumber自定义数字字段
field_emp_sele_xxxString自定义下拉字段(显示值)
field_emp_sele_xxx_sourceArray自定义下拉字段选项详情

枚举值说明#

employeeStatus 员工状态#

valuelabel
probation试用
formal正式
working在职
quitted离职

employeeType 员工类型#

valuelabel
regular全职
part_time兼职
internship实习
dispatching劳务派遣
restart退休返聘
epiboly劳务外包

gender 性别#

valuelabel
male男
female女

idType 证件类型#

valuelabel
identity_card居民身份证
hk_and_macao_id港澳居民往来内地通行证
taiwan_id台湾居民往来大陆通行证
passport护照
others其他

maritalStatus 婚姻状况#

valuelabel
spinsterhood未婚
married已婚
divorced离异
bereft丧偶
separation分居

politicalStatus 政治面貌#

valuelabel
masses群众
league_member团员
communist党员
other其他

operate 所属操作#

valuelabel
onboarding入职
offboarding离职
jobchange调动
other其他调整

operateType 操作类型#

valuelabel
firstOnBoarding首次入职
reOnBoarding再入职
activeOffBoarding主动离职
passiveOffBoarding被动离职
employeeTypeChange员工类型变更
specialChange特殊调整
promotion晋升
demotion降级
transfer调动

delete 删除状态#

valuelabel
normal正常
(UUID)已删除

_source 选项详情结构#

带 _source 后缀的字段返回选项的详细信息:
字段名类型描述
labelString选项显示名称
valueString选项值(用于数据存储和接口传参)
orderInteger排序号(可为null)
statusString选项状态(normal-正常,stop-停用)
markValueString标记值(可为null)
orgLabelString组织标签(可为null)

文件对象结构#

文件类型字段(如 portraitSidePhotoOfId)返回数组,每个元素结构:
字段名类型描述
empIdString员工ID
corpIdString企业ID
fileNameString文件名
ossKeyStringOSS存储路径
keyString相对路径
sizeNumber文件大小(字节)
timeString上传时间(格式:yyyy_MM_dd_HH_mm_ss_SSS)

审批信息结构#

approvalInfos 字段返回数组,每个元素结构:
字段名类型描述
empFormTempleTypeString审批表单类型(如 JOB_CHANGE)
processInstanceIdString审批流程实例ID
approvalStatusString审批状态(PASSED-已通过,REJECTED-已拒绝,RUNNING-进行中)

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Body 参数application/json

示例
{
    "corpId": "string",
    "orgIds": [
        "string"
    ],
    "employeeStatus": "string",
    "pageSize": 30,
    "page": 1,
    "effectDate": "string"
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location 'https://app91651.eapps.dingtalkcloud.com/open/api/v1/employee/list' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "corpId": "string",
    "orgIds": [
        "string"
    ],
    "employeeStatus": "string",
    "pageSize": 30,
    "page": 1,
    "effectDate": "string"
}'

返回响应

🟢200成功
application/json
Bodyapplication/json

示例
{
    "data": {
        "list": [
            {
                "empId": "xxx",
                "gmtModified": "xxx",
                "mobileNumber": "xxx",
                "employeeType_source": [
                    {
                        "label": "xxx",
                        "value": "xxx",
                        "order": 0,
                        "status": "normal",
                        "markValue": null
                    }
                ],
                "idNumber": "xxx",
                "delete": "normal",
                "employeeStatus": "xxx",
                "idType_source": [
                    {
                        "label": "xxx",
                        "value": "xxx",
                        "order": 4,
                        "status": "normal",
                        "markValue": null
                    }
                ],
                "onBoardingDate": "xxx",
                "id": "xxx",
                "department": "xxx",
                "effectDate": "xxx",
                "employeeStatus_source": [
                    {
                        "label": "xxx",
                        "value": "xxx",
                        "order": 1,
                        "status": "normal",
                        "markValue": null
                    }
                ],
                "idType": "xxx",
                "corpId": "xxx",
                "operateType": "xxx",
                "gmtCreate": "xxx",
                "invalidDate": "xxx",
                "operate": "xxx",
                "employeeType": "xxx",
                "syncDingTalk": "xxx",
                "companySeniorityAge": "xxx",
                "mainDepartment_source": [
                    {
                        "label": "xxx",
                        "value": "xxx",
                        "order": null,
                        "status": null,
                        "markValue": null
                    }
                ],
                "effectVersion": "xxx",
                "name": "xxx",
                "department_source": [
                    {
                        "label": "xxx",
                        "value": "xxx",
                        "order": null,
                        "status": null,
                        "markValue": null
                    }
                ],
                "mainDepartment": "xxx"
            }
        ],
        "total": 0,
        "page": 0,
        "pageSize": 0,
        "notDataPermission": false
    },
    "success": false,
    "errorCode": "",
    "errorMsg": ""
}
修改于 2026-03-31 03:07:01
上一页
获取待入职记录元数据
下一页
获取企业员工详情
Built with