员工查询¶
获取组织的员工列表¶
使用场景：按组织获取所有员工列表，结果不包含已离职员工。
请求方式：GET（HTTPS）
请求地址：https://openapi.2haohr.com/api/employees/dept_simple_list/?access_token=ACCESS_TOKEN
参数说明：
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
| department_id | String | 是 | 组织id |
| fetch_child | String | 否 | 1/0：是否递归获取子组织下面的成员 |
| limit | String | 否 | 每页大小，[0,100] ,默认20 |
| p | String | 否 | 查询页码 |
权限说明
返回结果：结果不包含已离职员工
{
"errcode": 0,
"errmsg": "",
"data": {
"p": 1,
"limit": 20,
"offset": 0,
"total_count": 10,
"totalpage": 1,
"objects": [
{
"id": "686460*****44f2987db8*****079b89",
"name": "zhangsan",
"department_id": "f634e2*****f45788b2c3*****ccaa77"
},
{
"id": "40e22f*****84a46908c8*****81576e",
"name": "lisi",
"department_id": "f634e2*****f45788b2c3*****ccaa77"
}
]
}
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| p | 页码 |
| limit | 每页大小 |
| total_count | 总计 |
| totalpage | 总页数 |
| objects | 员工列表 |
| data | 返回数据 |
| id | 员工id |
| name | 员工名称 |
| department_id | 组织id |
获取组织员工信息¶
使用场景：按组织获取所有员工的详细信息，包含子组织；可以选择返回已离职员工和不返回已离职员工信息。
请求方式：GET（HTTPS）
请求地址：https://openapi.2haohr.com/api/employees/dept_list/?access_token=ACCESS_TOKEN
参数说明：
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
| department_id | String | 否 | 组织id |
| fetch_child | String | 否 | 1/0：是否递归获取子组织下面的成员 |
| get_left_emp | String | 否 | 1/0：是否获取已离职员工信息，默认为不获取 |
| limit | String | 否 | 每页大小，[0,100] ,默认20 |
| p | String | 否 | 查询页码 |
权限说明
返回结果：get_left_emp为1的时候，返回包含已离职员工的信息，get_left_emp不为1的时候，返回不包含已离职员工的员工信息
{
"errcode": 0,
"errmsg": "",
"data": {
"p": 1,
"limit": 20,
"offset": 0,
"total_count": 10,
"totalpage": 1,
"objects": [
{
"id": "686460*****44f2987db8*****079b89",
"name": "zhangsan",
"english_name": "zhangsan",
"emp_no": "100010",
"mobile": "1592****610",
"email": "81*****671@163.com",
"work_email": "19*****810@163.com",
"job_title_number": "12123",
"serial_no": "1123",
"credentials_type": 1,
"credentials_no": "54df88*****cb74c73cd00cd4*****9f263b",
"work_type": 1,
"work_status": 2,
"hire_date": "2018-01-01",
"work_start_date": "2018-01-01",
"probation": 1,
"department_id": "f634e2*****f45788b2c3*****ccaa77",
"job_position_id": "a7d716*****646d680fca*****c3d8d3",
"job_level_id": "69e319*****045e28a09a*****5f83f9",
"work_place_id": "c98326*****244afbaa50*****fd450e",
"contract_company_id": "9faec9******d4c959d8af*****8c2bd5",
"emp_oa_code": "",
"birthday": "1999-09-09",
"work_hour": 1
}
]
}
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| data | 返回数据 |
| id | 员工id |
| name | 员工名称 |
| english_name | 英文名 |
| mobile | 手机号码 |
| emp_no | 员工工号 |
| 个人邮箱 | |
| work_email | 工作邮箱 |
| job_title_number | 岗位编码 |
| serial_no | 组织编码 |
| credentials_type | 证件类型 1:身份证 2:外国护照 5:台湾居民来往大陆通行证 6:港澳居民来往内地通行证 7:其他 8:香港身份证 9:台湾身份证 10:澳门身份证 11:外国人永久居留证 |
| credentials_no | 证件号码 |
| work_type | 员工性质 0:全职;1:兼职;2:实习生;3:退休返聘;4:劳务派遣;5:外包;6:劳务;7:派遣;8:小时工;9:临时工;10:社会兼职;11:学生兼职;12:借调;99:其他; |
| work_status | 员工状态 |
| hire_date | 员工入职日期 |
| work_start_date | 司龄开始日期 |
| probation | 员工试用期(null:未设置,0:无试用期,1~12:表示N个月,15～90:表示N天) |
| department_id | 组织id |
| job_position_id | 岗位id |
| job_level_id | 岗位职级id |
| work_place_id | 办公地点id |
| contract_company_id | 合同公司id |
| emp_oa_code | 员工OA编码 |
| birthday | 员工生日 |
| work_hour | 工时制度 1标准工时制；2综合工时制；3不定时工时制；4其他非全日制 |
查找员工¶
使用场景：按关键字条件（姓名，手机号，邮箱）查找员工信息
请求方式：GET（HTTPS）
请求地址：https://openapi.2haohr.com/api/employees/search/?access_token=ACCESS_TOKEN
参数说明（后续可扩展更多的查询条件）
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
| keyword | String | 否 | 关键字（姓名，手机号，邮箱，工号） |
| work_type | Int | 否 | 员工性质：0:全职;1:兼职;2:实习生;3:退休返聘;4:劳务派遣;5:外包;6:劳务;7:派遣;8:小时工;9:临时工;10:社会兼职;11:学生兼职;12:借调;99:其他; |
| work_status | Int | 否 | 员工状态：1:试用期;2:正式;3:待离职; 4:已离职;(在职状态：包含试用期，正式，待离职) |
| limit | String | 否 | 每页大小，[0,100] ,默认20 |
| p | String | 否 | 查询页码 |
权限说明
返回结果：
{
"errcode": 0,
"errmsg": "",
"data":{
"p": 1,
"limit": 20,
"offset": 0,
"total_count": 10,
"totalpage": 1,
"objects": [{
"id": "686460*****44f2987db8*****079b89",
"name": "zhangsan",
"department_id": "f634e2*****f45788b2c3*****ccaa77"
}, {
"id": "40e22f*****84a46908c8*****81576e",
"name": "lisi",
"department_id": "f634e2*****f45788b2c3*****ccaa77"
}]
}
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| p | 页码 |
| limit | 每页大小 |
| total_count | 总计 |
| totalpage | 总页数 |
| objects | 员工列表 |
| data | 返回数据 |
| id | 员工id |
| name | 员工名称 |
| department_id | 组织id |
查找待入职员工¶
使用场景：按关键字条件（姓名，手机号，邮箱）查找待入职员工信息。
请求方式：GET（HTTPS）
请求地址：https://openapi.2haohr.com/api/intention_employee/search/?access_token=ACCESS_TOKEN
参数说明（后续可扩展更多的查询条件）
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
| keyword | String | 否 | 关键字（姓名，手机号，邮箱，工号） |
| work_type | Int | 否 | 员工性质：0:全职;1:兼职;2:实习生;3:退休返聘;4:劳务派遣;5:外包;6:劳务;7:派遣;8:小时工;9:临时工;10:社会兼职;11:学生兼职;12:借调;99:其他; |
| limit | String | 否 | 每页大小，[0,100] ,默认20 |
| p | String | 否 | 查询页码 |
权限说明
{
"errcode": 0,
"errmsg": "",
"data":{
"p": 1,
"limit": 20,
"offset": 0,
"total_count": 10,
"totalpage": 1,
"objects": [{
"id": "686460*****44f2987db8*****079b89",
"name": "zhangsan",
"department_id": "f634e2*****f45788b2c3*****ccaa77",
"hire_date": "2023-04-11",
"mobile": "13512345679",
"job_position_id": "d6340f2a*****a88*****029fa4750d6",
"job_position_name": "xxx"
}, {
"id": "40e22f*****84a46908c8*****81576e",
"name": "lisi",
"department_id": "f634e2*****f45788b2c3*****ccaa77",
"hire_date": "2023-04-11",
"mobile": "13512345678",
"job_position_id": "d6340f2a*****a88*****029fa4750d6",
"job_position_name": "xxx"
}]
}
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| p | 页码 |
| limit | 每页大小 |
| total_count | 总计 |
| totalpage | 总页数 |
| objects | 员工列表 |
| data | 返回数据 |
| id | 员工id |
| name | 员工名称 |
| department_id | 组织id |
| hire_date | 入职日期 |
| mobile | 员工手机号 |
| job_position_id | 岗位id |
| job_position_name | 岗位名称 |
查找组织员工¶
使用场景：按关键字（员工姓名）查找部门及子部门下面员工。
请求方式：GET（HTTPS）
请求地址：https://openapi.2haohr.com/api/employees/dept_search/?access_token=ACCESS_TOKEN
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
| department_id | String | 是 | 组织id |
| keyword | String | 是 | 关键字 (员工姓名) |
| fetch_child | String | 否 | 1/0：是否递归获取子组织下面的成员 |
| limit | String | 否 | 每页大小，[0,100] ,默认20 |
| p | String | 否 | 查询页码 |
权限说明
返回结果：
{
"errcode": 0,
"errmsg": "",
"data":{
"p": 1,
"limit": 20,
"offset": 0,
"total_count": 10,
"totalpage": 1,
"objects": [{
"id": "686460*****44f2987db8*****079b89",
"name": "zhangsan",
"department_id": "f634e2*****f45788b2c3*****ccaa77"
}, {
"id": "40e22f*****84a46908c8*****81576e",
"name": "lisi",
"department_id": "f634e2*****f45788b2c3*****ccaa77"
}]
}
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| p | 页码 |
| limit | 每页大小 |
| total_count | 总计 |
| totalpage | 总页数 |
| objects | 员工列表 |
| data | 返回数据 |
| id | 员工id |
| name | 员工名称 |
| department_id | 组织id |
获取离职员工列表¶
使用场景：通过此接口可获取离职的员工列表，包括员工姓名，离职日期，离职原因等。
请求方式：GET（HTTPS）
请求地址：https://openapi.2haohr.com/api/employees/leave_list/?access_token=ACCESS_TOKEN
参数说明：参数均为可选，但必须提供一个，否则返回空
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
| limit | Int | 否 | 每页大小，[0,100] ,默认20 |
| p | Int | 否 | 查询页码, 默认1 |
| leave_date | String | 否 | 离职时间, 可使用(年-月-日，年-月，年)三种模式，如: 2019-01-01, 2019-01, 2019 |
权限说明
返回结果：
{
"errcode": 0,
"errmsg": "",
"data":{
"p": 1,
"limit": 20,
"offset": 0,
"total_count": 10,
"totalpage": 1,
"objects": [{
"id": "e7996820-a172-4509-9ee4-952bbca9c34f",
"name": "李四",
"department_id": "c94d9ec6-fab8-4ca3-bacf-bc1927f625b7",
"leave_date": "2023-03-31",
"leave_reason": "主动离职-交通不便",
"leave_reason_id": "4",
"emp_no": "101",
"salary_settlement_date": "2023-03-31",
"leave_type_id": "33bb3bec-25ab-430d-9760-51e46b079a2e",
"leave_type_name": "主动离职"
},
{
"id": "f4e5c6d5-3ed4-436a-87e3-a9e9a8a380c0",
"name": "张三",
"department_id": "416d4544-eeba-41d5-928c-c4d88fd9669b",
"leave_date": "2023-03-31",
"leave_reason": "被动离职-违反公司条例",
"leave_reason_id": "12",
"emp_no": "100",
"salary_settlement_date": "2023-03-31",
"leave_type_id": "1c242d55-f2e8-4ca1-b8d7-c9a81ae04e1d",
"leave_type_name": "被动离职"
}]
}
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| p | 页码 |
| limit | 每页大小 |
| total_count | 总计 |
| totalpage | 总页数 |
| objects | 员工列表 |
| data | 返回数据 |
| id | 员工id |
| name | 员工名称 |
| department_id | 组织id |
| leave_date | 离职日期 |
| leave_reason_id | 离职原因id |
| leave_reason | 离职原因 |
| emn_no | 员工工号 |
| salary_settlement_date | 薪资结算日 |
| leave_type_id | 离职类型id |
| leave_type_name | 离职类型名称 |
查找离职员工¶
使用场景：按关键字条件（姓名、手机号、邮箱）查找离职员工，返回离职员工的离职日期、离职原因信息。
请求方式：GET（HTTPS）
请求地址：https://openapi.2haohr.com/api/employees/leave_search/?access_token=ACCESS_TOKEN
参数说明
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
| keyword | String | 否 | 关键字（姓名、手机号、个人邮箱） |
| limit | String | 否 | 每页大小，[0,100] ,默认20 |
| p | String | 否 | 查询页码 |
权限说明
返回结果：
{
"errcode": 0,
"errmsg": "",
"data":{
"p": 1,
"limit": 20,
"offset": 0,
"total_count": 10,
"totalpage": 1,
"objects": [{
"id": "f4e5c6d5-3ed4-436a-87e3-a9e9a8a380c0",
"name": "张三",
"leave_date": "2023-03-31",
"leave_reason": "被动离职-违反公司条例",
"leave_reason_id": "12",
"leave_type_id": "1c242d55-f2e8-4ca1-b8d7-c9a81ae04e1d",
"leave_type_name": "被动离职"
}]
}
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| p | 页码 |
| limit | 每页大小 |
| total_count | 总计 |
| totalpage | 总页数 |
| objects | 员工列表 |
| data | 返回数据 |
| id | 员工id |
| name | 员工名称 |
| leave_date | 离职日期 |
| leave_reason_id | 离职原因id |
| leave_reason | 离职原因 |
| leave_type_id | 离职类型id |
| leave_type_name | 离职类型名称 |
获取待离职员工信息列表¶
使用场景：使用参数查询待离职的员工信息，用于第三方系统主动拉取员工状态变更同步。
请求方式：GET（HTTPS）
请求地址：https://openapi.2haohr.com/api/employees/leaving_list/?access_token=ACCESS_TOKEN
参数说明
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
| leave_date | string | 否 | 离职日期, 日期格式yyyy-mm-dd，示例： 2020-03-20，两个日期必须存在其中一个，优先使用leave_date |
| leave_approved_date | string | 否 | 离职审批通过日期, 日期格式yyyy-mm-dd，示例： 2020-03-20， 两个日期必须存在其中一个，优先使用leave_date |
| limit | int | 否 | 每页大小，[0,100] ,默认20 |
| p | int | 否 | 查询页码 |
权限说明
返回结果：
{
"errcode": 0,
"errmsg": "",
"data":{
"p": 1,
"limit": 20,
"offset": 0,
"total_count": 10,
"totalpage": 1,
"objects": [{
"leave_type_id": "33bb3bec-25ab-430d-9760-51e46b079a2e",
"formal_date": "2023-04-03",
"name": "章先生",
"hire_date": "2023-04-03",
"leave_reason_id": 8,
"leave_type_name": "主动离职",
"leave_apply_date": "2023-04-07",
"leave_date": "2023-04-07",
"leave_reason": "主动离职-职业规划",
"leave_approved_date": "2023-04-07",
"id": "6d18f2eb-9926-4ab8-839f-336427c911fd"
}]
}
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| p | 页码 |
| limit | 每页大小 |
| total_count | 总计 |
| totalpage | 总页数 |
| objects | 员工列表 |
| data | 返回数据 |
| id | 员工id, 必返回 |
| name | 员工名称， 必返回 |
| leave_date | 离职日期 |
| leave_reason_id | 离职原因id |
| leave_reason | 离职原因 |
| hire_date | 入职日期 |
| formal_date | 转正日期 |
| leave_apply_date | 申请离职日期 |
| leave_approved_date | 离职申请通过日期 |
| leave_type_id | 离职类型id |
| leave_type_name | 离职类型名称 |
获取工资卡信息社保卡信息¶
使用场景：返回企业内员工工资卡和社保卡的列表。
请求方式：GET（HTTPS）
请求地址：https://openapi.2haohr.com/api/employees/?access_token=ACCESS_TOKEN
参数说明
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
| limit | Number | 否 | 每页大小，[0,100] ,默认20 |
| p | Number | 否 | 查询页码 |
权限说明
返回结果：
{
"errcode": 0,
"errmsg": "",
"data": {
"p": 1,
"limit": 20,
"offset": 0,
"total_count": 10,
"totalpage": 1,
"objects": [
{
"id": "686460*****44f2987db8*****079b89",
"emp_name": "zhangsan",
"wage_card_no": "7dcb14*****57fc2eb3a7*****011732",
"bank": "xx银行xx支行",
"bank_name": "xx银行",
"bank_province_name": "广东",
"bank_city_name": "深圳",
"bank_town_name": "南山区",
"socical_security_pc_no": "eca7e0*****ec1b359519c725*****f256e7",
"housing_fund_no": "422cd1****245b46"
},
{
"id": "2",
"emp_name": "lisi",
"wage_card_no": "eea3e0*****cc1b3525b9d745*****ff5be8",
"bank": "xx银行xx支行",
"bank_name": "xx银行",
"bank_province_name": "广东",
"bank_city_name": "广州",
"bank_town_name": "天河区",
"socical_security_pc_no": "f4a8c2*****f8686d46e06b0b*****431509",
"housing_fund_no": "a31b75****d1bedb"
}
]
}
}
参数说明：
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| data | 返回数据 |
| p | 页码 |
| limit | 每页大小 |
| total_count | 总计 |
| totalpage | 总页数 |
| objects | 员工列表 |
| id | 员工id |
| emp_name | 员工名称 |
| wage_card_no | 工资卡号 |
| bank_name | 银行名称 |
| bank | 工资卡开户行 |
| bank_province_name | 开户行省份名称 |
| bank_city_name | 开户行城市名称 |
| bank_town_name | 开户行区县名称 |
| socical_security_pc_no | 社保电脑号 |
| housing_fund_no | 公积金账号 |