员工信息

新增员工


使用场景:通过该接口新增2号员工信息。

请求方式: POST(HTTPS)

请求地址: https://openapi.2haohr.com/api/employees/create/?access_token=ACCESS_TOKEN

请求参数

参数 类型 是否必填 参数说明
access_token String 调用接口凭证
emp_name String 员工姓名
english_name String 英文名
sex Number 性别 0:未知;1:男;2:女
mobile String 手机号码
email String 个人邮箱
credentials_type Number 证件类型(默认为1) 1:身份证 2:外国护照 5:台湾居民来往大陆通行证 6:港澳居民来往内地通行证 7:其他 8:香港身份证 9:台湾身份证 10:澳门身份证 11:外国人永久居留证
credentials_no String 证件号码
hire_date String 入职时间(默认为当天)
probation Number 试用期(null:未设置,0:无试用期,1~12:表示N个月,15~90:表示N天)
contract_company_name String 合同公司
dept_name String 组织全称(以斜杠'/'分隔)
job_position_name String 职务
job_title_name String 岗位
job_level_name String 职级
work_type Number 工作性质: 0:全职;1:兼职;2:实习生;3:退休返聘;4:劳务派遣;5:外包;6:劳务;7:派遣;8:小时工;9:临时工;10:社会兼职;11:学生兼职;12:借调;99:其他;
work_status Number 员工状态: 1: 试用期 2: 正式
emp_no String 工号
work_place_name String 工作地点
work_city_name String 工作城市
work_email String 工作邮箱
emp_oa_code String 员工OA编码
report_leader_id String 汇报上级id
report_leader_name String 汇报上级名称
first_work_date String 参加工作时间
wage_card_no String 工资卡卡号
bank_city_name String 工资卡开户城市
bank String 工资卡开户行
attendance_no String 考勤编号
residential_address String 现居住地,不能超过200个字
credentials_effective_date String 身份证有效期, 格式:2027-12-02
nation String 民族,中文字符串,如:汉族,哈萨克族
native_province_name String 籍贯省份,如:广东省
native_city_name String 籍贯城市,如:深圳市
account_type Number 户口性质,枚举值: 5-城镇户口,6-农村户口,7-居民户口
account_address String 户籍地址
birthday String 生日,格式:1990-10-01
birthday_in_lunar Number 是否使用农历生日, 1-是,0-否。
politics_status Number 政治面貌, 枚举值:1-中共党员,2-共青团员,3-普通居民/群众,4-中共预备党员,5-民革党员,6-民盟盟员,7-民建会员,8-民进会员,9-农工党党员,10-致公党党员,11-九三学社社员,12-台盟盟员,13-无党派民主人士
is_married Number 是否已婚 , 0-未婚,1-已婚,2-离异,3-丧偶。
has_children Number 是否已育 , 1-是,0-否。
field_xxxx String 自定义字段 (企业在人事档案设置模块添加的员工自定义属性字段,自定义字段的配置可以通过【获取员工自定义属性配置】接口获取)

注意: 合同公司默认为access_token信息所属的公司

返回结果

{
    "data": {
        "job_position_name": null,
        "sex": 0,
        "job_title_name": "",
        "work_status": 1,
        "work_city_name": null,
        "english_name": "",
        "probation": 0,
        "id": "ec8e7c*****f453b9fca8*****9dba19",
        "dept_name": "互联网产品部/技术中心/后端一组",
        "work_place_name": "",
        "emp_oa_code": "",
        "email": "",
        "job_level_name": "",
        "work_type": 0,
        "contract_company_name": "冰霜之境",
        "credentials_type": 1,
        "emp_name": "刘能",
        "work_email": "",
        "credentials_no": "",
        "emp_no": "",
        "mobile": "",
        "hire_date": "2019-06-16",
        "report_leader_id": "",
        "report_leader_name": "",
        "first_work_date": "2011-11-11",
        "wage_card_no": "",
        "bank_city_name": "四川/德阳/中江县",
        "bank": "中信银行南山支行",
        "attendance_no": "1009",
        "credentials_effective_date": "2027-12-02",
        "residential_address": "广东省深圳市南山区科技中三路国人通讯大厦B601",
        "nation": "汉族",
        "native_province_name": "广东省",
        "native_city_name": "东莞市",
        "account_type": 6,
        "account_address": "广东省深圳市南山区科技中三路国人通讯大厦B601",
        "birthday": "1999-09-01",
        "birthday_in_lunar": 0,
        "politics_status": 2,
        "is_married": 0,
        "has_children": 0,
        "field_206419": "广东省深圳市南山区"
    },
    "errcode": 0,
    "errmsg": "",
}

编辑员工


使用场景:此接口用于更新员工信息。

请求方式: POST(HTTPS)

请求地址: https://openapi.2haohr.com/api/employees/update/?access_token=ACCESS_TOKEN

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
id String 员工id
emp_name String 员工姓名
english_name String 英文名称
sex Number 性别 0:未知;1:男;2:女
mobile String 手机号码( 如果该手机号绑定了员工微信服务则无法修改)
email String 个人邮箱
credentials_type Number 证件类型 1:身份证 2:外国护照 5:台湾居民来往大陆通行证 6:港澳居民来往内地通行证 7:其他 8:香港身份证 9:台湾身份证 10:澳门身份证 11:外国人永久居留证
credentials_no String 证件号码
hire_date String 入职时间
probation Number 试用期(null:未设置,0:无试用期,1~12:表示N个月,15~90:表示N天)
contract_company_name String 合同公司
dept_name String 组织全称(以斜杠'/'分隔)
job_position_name String 职务
job_title_name String 岗位
job_level_name String 职级
work_type Number 工作性质 0:全职;1:兼职;2:实习生;3:退休返聘;4:劳务派遣;5:外包;6:劳务;7:派遣;8:小时工;9:临时工;10:社会兼职;11:学生兼职;12:借调;99:其他;
work_status Number 员工状态 1: 试用期 2: 正式 3:待离职 4: 已离职
emp_no String 工号
work_place_name String 工作地点
work_city_name String 工作城市
work_email String 工作邮箱
emp_oa_code String 员工OA编码
report_leader_id String 汇报上级id
report_leader_name String 汇报上级名称
sub_dep Array(Object) 兼任部门信息(sub_dep_id: 兼职部门id, sub_job_title_id: 兼职岗位id)
first_work_date String 参加工作时间
wage_card_no String 工资卡卡号
bank_city_name String 工资卡开户城市
bank String 工资卡开户行
attendance_no String 考勤编号
residential_address String 现居住地
credentials_effective_date String 身份证有效期, 格式:2027-12-02
nation String 民族,中文字符串,如:汉族,哈萨克族
native_province_name String 籍贯省份,如:广东省
native_city_name String 籍贯城市,如:深圳市
account_type Number 户口性质,枚举值: 5-城镇户口,6-农村户口,7-居民户口
account_address String 户籍地址
birthday String 生日,格式:1990-10-01
birthday_in_lunar Number 是否使用农历生日, 1-是,0-否。
politics_status Number 政治面貌, 枚举值:1-中共党员,2-共青团员,3-普通居民/群众,4-中共预备党员,5-民革党员,6-民盟盟员,7-民建会员,8-民进会员,9-农工党党员,10-致公党党员,11-九三学社社员,12-台盟盟员,13-无党派民主人士
is_married Number 是否已婚 , 0-未婚,1-已婚,2-离异,3-丧偶。
has_children Number 是否已育 , 1-是,0-否。
field_xxxx String 自定义字段 (企业在人事档案设置模块添加的员工自定义属性字段,自定义字段的配置可以通过【获取员工自定义属性配置】接口获取)

返回结果

{
    "data": {
        "job_position_name": null,
        "sex": 1,
        "job_title_name": "",
        "work_status": 1,
        "work_city_name": null,
        "english_name": "",
        "probation": 0,
        "id": "ec8e7c*****f453b9fca8*****9dba19",
        "dept_name": "互联网产品部/技术中心/后端一组",
        "work_place_name": "",
        "emp_oa_code": "",
        "email": "",
        "job_level_name": "",
        "work_type": 0,
        "contract_company_name": "冰霜之境",
        "credentials_type": 1,
        "emp_name": "张良",
        "work_email": "",
        "credentials_no": "",
        "emp_no": "",
        "mobile": "",
        "hire_date": "2019-06-17",
        "report_leader_id": "761714*****e4c15b2037*****33f0ce",
        "report_leader_name": "张大大",
        "sub_dep": [{
            "sub_dep_id": "03d04e*****442d3b21*****ec272e24",
            "sub_job_title_id": "15asd8*****we855412*****7878qwe1"
        }],
        "first_work_date": "2011-11-11",
        "wage_card_no": "",
        "bank_city_name": "四川/德阳/中江县",
        "bank": "中信银行南山支行",
        "attendance_no": "1008",
        "credentials_effective_date": "2027-12-02",
        "residential_address": "广东省深圳市南山区科技中三路国人通讯大厦B601",
        "nation": "汉族",
        "native_province_name": "广东省",
        "native_city_name": "东莞市",
        "account_type": 6,
        "account_address": "广东省深圳市南山区科技中三路国人通讯大厦B601",
        "birthday": "1999-09-01",
        "birthday_in_lunar": 0,
        "politics_status": 2,
        "is_married": 0,
        "has_children": 0,
        "field_206419": "广东省深圳市南山区"
    },
    "errcode": 0,
    "errmsg": "",
}

删除员工


使用场景:该接口可用于删除2号员工信息,如在企业OA中删除了员工信息后,同步更新到2号中。

请求方式:POST(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/delete/?access_token=ACCESS_TOKEN

请求示例:

{
    "ids": ["xxxxxxxxx"]
}

参数说明:

参数 类型 是否必须 说明
ids String数组 员工id的数组(长度最大为100)

返回结果

{
  "errcode": 0,
  "errmsg": "",
  "data": {
    "ids": []
  }
}

返回值说明:

参数 类型 是否必须 说明
ids String数组 已删除的员工id的数组

获取员工信息


使用场景:该接口可用于获取2号员工所有的信息。

请求方式:GET(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/{id}/?access_token=ACCESS_TOKEN

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
id String 员工id

权限说明

返回结果:

{
   "errcode": 0,
   "errmsg": "",
   "data": {
      "id": "686460*****44f2987db8*****079b89",
      "name": "zhangsan",
      "nickname": "zs",
      "english_name": "zhangsan",
      "emp_no": "100010",
      "mobile": "1592****610",
      "email": "81*****671@163.com",
      "work_email": "176****1764@163.com",
      "job_title_number": "12123",
      "serial_no": "1123",
      "credentials_type": 1,
      "credentials_no": "132****9800****023",
      "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": "a7d716dd665646d680fcae47a8c3d8d3",
      "job_level_id": "69e319*****045e28a09a*****5f83f9",
      "work_place_id": "c98326*****244afbaa50*****fd450e",
      "contract_company_id": "9faec9******d4c959d8af*****8c2bd5",
      "emp_oa_code": "",
      "dept_oa_code": "",
      "report_leader_id": "29e319*****045e28a09a*****cd83f8",
      "report_leader_name": "lisi",
      "sub_dep": [{
          "sub_dep_id": "03d04e*****442d3b21*****ec272e24",
          "sub_job_title_id": "15asd8*****we855412*****7878qwe1"
      }],
      "first_work_date": "2017-07-01",
      "job_duties_id": "77afed*****144dca0ab7*****1a4e9c",
      "job_duties_name": "产品部经理",
      "wage_card_no": "",
      "bank_city_name": "四川/成都/金牛区",
      "bank": "中信银行南山支行",
      "sex": 1,
      "age": 20,
      "work_province_name": "天津",
      "work_city_name": "天津",
      "work_town_name": "蓟州区",
      "bank_name": "成都农商银行",
      "ov_education": 0,
      "recruit": "内部推荐",
      "extension": "分机号码",
      "work_tel": "工作电话",
      "birthday": "1999-09-09",
      "work_hour": 1,
      "attendance_no": "sz1009",
      "formal_dt": "2024-07-23"
   }
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
id 员工id
name 员工名称
nickname 员工别名
english_name 英文名
mobile 手机号码
emp_no 员工工号
email 个人邮箱
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 员工状态 1:试用期;2:正式;3:待离职;4:已离职;
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编码
dept_oa_code 组织OA编码
report_leader_id 汇报上级ID
report_leader_name 汇报上级
sub_dep 兼任部门信息(sub_dep_id: 兼职部门id, sub_job_title_id: 兼职岗位id)
first_work_date 参加工作时间
job_duties_id 职务id
job_duties_name 职务名称
wage_card_no 工资卡卡号
bank_city_name 工资卡开户城市
bank 工资卡开户行
sex 性别 0:未填写;1:男;2:女
age 年龄
work_province_name 工作省份
work_city_name 工作城市
work_town_name 工作区县
bank_name 银行名称
ov_education 最高学历 0:未填写,1:小学,2:初中,3:高中,4:大专,5:本科,6:硕士,7:博士,8:职业高级中学(原职高),9:中等专业学校(原中专),10:中级技工学校(原技校),11:其他,12:博士后,13:中等师范学校,14:高级技工学校
recruit 招聘渠道
extension 分机号码
work_tel 工作电话
birthday 员工生日
work_hour 工时制度 1标准工时制;2综合工时制;3不定时工时制;4其他非全日制
attendance_no 考勤编号
formal_dt 转正日期

获取员工的基本信息


使用场景:获取员工的基本信息,含姓名、工号、岗位、所在城市、入职日期、工作邮箱、个人邮箱等。最多一次可获取100个员工。

请求方式:GET(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/base_info/?access_token=ACCESS_TOKEN&ids=IDS

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
ids String 员工id集合,用英文逗号分隔

权限说明

返回结果:

{
  "errcode": 0,
  "errmsg": "",
  "data": [
    {
      "id": "686460*****44f2987db8*****079b89",
      "name": "zhangsan",
      "nickname": "zs",
      "emp_no": "100010",
      "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",
      "work_city": "上海/上海/黄浦",
      "work_type": 1,
      "work_status": 2,
      "hire_date": "2018-01-01",
      "probation": 0,
      "email": "81*****671@163.com",
      "work_email": "81*****671@163.com",
      "job_title_number": "12123",
      "serial_no": "1123",
      "age": 20,
      "sex": 1,
      "emp_oa_code": "",
      "dept_oa_code": "",
      "report_leader_id": "",
      "report_leader_name": "",
      "sub_dep": [{
          "sub_dep_id": "03d04e*****442d3b21*****ec272e24",
          "sub_job_title_id": "15asd8*****we855412*****7878qwe1"
      }],
      "first_work_date": "2017-07-01",
      "job_duties_id": "77afed*****144dca0ab7*****1a4e9c",
      "job_duties_name": "产品部经理",
      "mobile": "1588****610",
      "wage_card_no": "",
      "bank_city_name": "四川/成都/金牛区",
      "bank": "中信银行南山支行",
      "bank_name": "成都农商银行",
      "ov_education": 0,
      "recruit": "内部推荐",
      "english_name": "zhangsan",
      "credentials_type": 1,
      "credentials_no": "132****9800****023",
      "extension": "140-323435",
      "work_tel": "18877887788",
      "wework_openid": "ww0839762145xxx",
      "wework_user_id": "ww0839762145xxx",
      "dingtalk_user_id": "ww0839762145xxx",
      "formal_dt": "2024-07-23"
    },
    {
      "id": "40e22f*****84a46908c8*****81576e",
      "name": "lisi",
      "nickname": "ls",
      "emp_no": "100011",
      "department_id": "f634e2*****f45788b2c3*****ccaa77",
      "job_position_id": "6c1252*****843388759d*****68494f",
      "job_level_id": "69e319*****045e28a09a*****5f83f9",
      "work_place_id": "c98326*****244afbaa50*****fd450e",
      "contract_company_id": "9faec9*****d4c959d8af*****8c2bd5",
      "work_city": "广东/深圳/南山",
      "work_type": 1,
      "work_status": 3,
      "hire_date": "2015-10-17",
      "probation": 3,
      "email": "19*****810@163.com",
      "job_title_number": "12123",
      "serial_no": "1123",
      "work_email": "19*****810@163.com",
      "age": 25,
      "sex": 1,
      "emp_oa_code": "",
      "dept_oa_code": "",
      "report_leader_id": "",
      "report_leader_name": "",
      "sub_dep": [{
          "sub_dep_id": "03d04e*****442d3b21*****ec272e24",
          "sub_job_title_id": "15asd8*****we855412*****7878qwe1"
      }],
      "first_work_date": "2020-07-11",
      "job_duties_id": "77afed*****144dca0ab7*****1a4e9c",
      "job_duties_name": "产品部经理",
      "mobile": "1588****788",
      "wage_card_no": "",
      "bank_city_name": "四川/成都/金牛区",
      "bank": "中信银行南山支行",
      "bank_name": "成都农商银行",
      "ov_education": 0,
      "recruit": "内部推荐",
      "english_name": "lisi",
      "credentials_type": 1,
      "credentials_no": "132****9805****023",
      "extension": "140-323435",
      "work_tel": "18877887788",
      "wework_openid": "ww0839762146xxx",
      "wework_user_id": "ww0839762146xxx",
      "dingtalk_user_id": "ww0839762146xxx",
      "formal_dt": "2024-07-23"
    }
  ]
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 员工列表
id 员工id
name 员工名称
nickname 员工别名
emp_no 员工工号
department_id 组织id
job_position_id 岗位id
job_level_id 岗位职级id
work_place_id 办公地点id
contract_company_id 合同公司id
work_city 所在城市
work_type 员工性质 0:全职;1:兼职;2:实习生;3:退休返聘;4:劳务派遣;5:外包;6:劳务;7:派遣;8:小时工;9:临时工;10:社会兼职;11:学生兼职;12:借调;99:其他;
work_status 员工状态 1:试用期;2:正式;3:待离职;4:已离职;
hire_date 入职日期
probation 试用期(null:未设置,0:无试用期,1~12:表示N个月,15~90:表示N天)
email 个人邮箱
work_email 工作邮箱
job_title_number 岗位编码
serial_no 组织编码
age 年龄
sex 性别 0:未填写;1:男;2:女
emp_oa_code 员工OA编码
dept_oa_code 组织OA编码
report_leader_id 汇报上级ID
report_leader_name 汇报上级
sub_dep 兼任部门信息(sub_dep_id: 兼职部门id, sub_job_title_id: 兼职岗位id)
first_work_date 参加工作时间
job_duties_id 职务id
job_duties_name 职务名称
mobile 手机号码
wage_card_no 工资卡卡号
bank_city_name 工资卡开户城市
bank 工资卡开户行
bank_name 银行名称
ov_education 最高学历 0:未填写,1:小学,2:初中,3:高中,4:大专,5:本科,6:硕士,7:博士,8:职业高级中学(原职高),9:中等专业学校(原中专),10:中级技工学校(原技校),11:其他,12:博士后,13:中等师范学校,14:高级技工学校
recruit 招聘渠道
english_name 英文名
credentials_type 证件类型 1:身份证 2:外国护照 5:台湾居民来往大陆通行证 6:港澳居民来往内地通行证 7:其他 8:香港身份证 9:台湾身份证 10:澳门身份证 11:外国人永久居留证
credentials_no 证件号码
recruit 招聘渠道
extension 分机号码
work_tel 工作电话
wework_openid 企微用户openid(密文)
wework_user_id 企微用户openid(明文)
dingtalk_user_id 钉钉用户ID
formal_dt 转正日期

获取员工自定义属性配置


使用场景:用于获取员工自定义的属性配置,结果不包含已离职员工,也不包含已经弃用的字段。

请求方式:GET(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/custom/?access_token=ACCESS_TOKEN

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
limit String 每页大小,[0,100] ,默认20
p String 查询页码

权限说明

返回结果:结果不包含已离职员工,也不包含已经弃用的字段

{
  "errcode": 0,
  "errmsg": "",
  "data": {
    "p": 1,
    "limit": 20,
    "offset": 0,
    "total_count": 10,
    "totalpage": 1,
    "objects": [
      {
        "field_group": 10,
        "field_key": "field_206419",
        "field_name": "职业成就",
        "field_desc": "在职业生涯取得的辉煌成就",
        "field_type": 1,
        "field_options": []
      },
      {
        "field_group": 20,
        "field_key": "field_215577",
        "field_name": "婚姻状况",
        "field_desc": "个人婚姻状况",
        "field_type": 5,
        "filed_options": ["未婚", "已婚", "离异", "丧偶"]
      }
    ]
  }
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
p 页码
limit 每页大小
total_count 总计
totalpage 总页数
objects 员工列表
data 返回数据
field_group 所属分组 ((10, "在职信息"),(20, "基本信息"),(30, "联系信息"))
field_key 字段系统名称
field_name 字段显示名称
field_desc 字段说明
field_type 字段类型 (1, "文本字段")(2, "数字字段")(3, "日期字段")(4, "是否字段")(5, "选择字段")(6, "业务关联字段")(7, "长文本")
filed_options 字段选项,字段类型为5时使用

获取员工自定义属性值


使用场景:用户获取自定义属性值,结果不包含已离职员工,也不包含已经弃用的字段。

请求方式:GET(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/custom/value/?access_token=ACCESS_TOKEN&ids=IDS&keys=KEYS

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
ids String 员工id集合(一次最多100个),用英文逗号分隔
keys String 员工自定义属性key集合(一次最多100个),用英文逗号分隔

权限说明

返回结果:结果不包含已离职员工,也不包含已经弃用的字段

{
  "data": [
      {
        "emp_id": "40fefa*****5459492b5a*****9d6f8c",
        "emp_name": "王五",
        "list": [
            {
                "field_key": "field_215577",
                "field_name": "特长",
                "field_value": "骑马"
            },
            {
                "field_key": "nickname",
                "field_name": "别名",
                "field_value": null
            }
        ]
      }
  ],
  "errcode": 0,
  "errmsg": ""
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 返回数据
emp_id 员工id
emp_name 员工姓名
list 属性值列表
field_key 字段系统名称
field_name 字段显示名称
field_value 字段值

获取员工的敏感信息


使用场景:获取某个员工的个人敏感信息,含姓名、工号、手机号码、证件类型、证件号码等。最多一次可获取100个员工。

请求方式:GET(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/pravte_info/?access_token=ACCESS_TOKEN&ids=IDS

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
ids String 员工id集合,用英文逗号分隔

权限说明

返回结果:

{
  "errcode": 0,
  "errmsg": "",
  "data": [
    {
      "id": "686460*****44f2987db8*****079b89",
      "name": "zhangsan",
      "emp_no": "100010",
      "mobile": "1592****610",
      "email": "81*****671@163.com",
      "work_email": "81*****671@163.com",
      "job_title_number": "12123",
      "serial_no": "1123",
      "credentials_type": 1,
      "credentials_no": "54df88*****cb74c73cd00cd4*****9f263b",
      "address": "广东广州"
    },
    {
      "id": "40e22f*****84a46908c8*****81576e",
      "name": "lisi",
      "emp_no": "100011",
      "mobile": "1565****000",
      "email": "19*****810@163.com",
      "work_email": "81*****671@163.com",
      "job_title_number": "12123",
      "serial_no": "1123",
      "credentials_type": 1,
      "credentials_no": "1c2f99*****ea32c37de9c5b9*****e23f68",
      "address": "广东深圳"
     }
  ]
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 员工列表
id 员工id
name 员工名称
emp_no 员工工号
mobile 手机号
email 个人邮箱
work_email 工作邮箱
job_title_number 岗位编码
serial_no 组织编码
credentials_type 证件类型 1:身份证 2:外国护照 5:台湾居民来往大陆通行证 6:港澳居民来往内地通行证 7:其他 8:香港身份证 9:台湾身份证 10:澳门身份证 11:外国人永久居留证
credentials_no 证件号码
address 住址

获取员工的个人资料


使用场景:获取某个员工的个人资料,含姓名、工号、性别、民族、生日等。最多一次可获取100个员工。

请求方式:GET(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/personal_info/?access_token=ACCESS_TOKEN&ids=IDS

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
ids String 员工id集合,用英文逗号分隔

权限说明

返回结果:

{
  "errcode": 0,
  "errmsg": "",
  "data": [
    {
      "id": "686460*****44f2987db8*****079b89",
      "name": "zhangsan",
      "english_name": "zhangsan",
      "emp_no": "100010",
      "sex": 1,
      "birthday": "1995-12-14",
      "nation": "汉族",
      "is_married": 0,
      "has_children": 0,
      "politics_status": 1,
      "account_city": "上海",
      "account_type": 5,
      "account_address": "宝安区西乡街道乐群社区一栋8号"
    },
    {
      "id": "40e22f*****84a46908c8*****81576e",
      "name": "lisi",
      "english_name": "lisi",
      "emp_no": "100011",
      "sex": 1,
      "birthday": "1993-08-04",
      "nation": "汉族",
      "is_married": 1,
      "has_children": 1,
      "politics_status": 2,
      "account_city": "北京",
      "account_type": 6,
      "account_address": "宝安区西乡街道乐群社区一栋9号"
    }
  ]
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 员工列表
id 员工id
name 员工名称
english_name 员工英文名
emp_no 员工工号
sex 性别 0:未填写;1:男;2:女
birthday 生日
nation 民族
is_married 婚姻状况 0-未婚;1-已婚;2-离异;3-丧偶
has_children 是否生育
politics_status 政治面貌 1:党员;2:团员;3:群众
account_city 户籍城市
account_type 户口性质 5:城镇户口;6:农村户口;7:居民户口;
account_address 户籍地址

获取员工的职称列表


使用场景:获取员工的职称列表。最多一次可获取100个员工。

请求方式:GET(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/professional_title_list/?access_token=ACCESS_TOKEN&ids=IDS

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
ids String 员工id集合,用英文逗号分隔

权限说明

返回结果:

{
  "errcode": 0,
  "errmsg": "",
  "data": [
    {
      "id": "686460*****44f2987db8*****079b89",
      "name": "zhangsan",
      "list": [
        {
          "name": "职称1",
          "receive_dt": "2016-01-01",
          "rating_agency": "评定机构1",
          "certificate_number": "A123456789",
          "remark": "备注1",
          "professional_rank": 1,
          "is_primary": 1
        },
        {
          "name": "职称2",
          "receive_dt": "2017-01-01",
          "rating_agency": "评定机构2",
          "certificate_number": "B123456789",
          "remark": "备注2",
          "professional_rank": 2,
          "is_primary": 0
        }
      ]
    }
  ]
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 返回数据
id 员工id
name 员工名称
list 职称列表
name 职称名称
receive_dt 职称获取时间
rating_agency 职称评定机构
certificate_number 职称证书编号
remark 职称备注
professional_rank 职称级别 1:正高级;2:副高级;3:中级;4:助理级;5:员级
is_primary 是否最高职称 0:否;1:是

获取员工的证书/证件列表


使用场景:获取员工的证书/证件列表。最多一次可获取100个员工。

请求方式:GET(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/certificate_list/?access_token=ACCESS_TOKEN&ids=IDS

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
ids String 员工id集合,用英文逗号分隔

权限说明

返回结果:

{
  "errcode": 0,
  "errmsg": "",
  "data": [
    {
      "id": "686460*****44f2987db8*****079b89",
      "name": "zhangsan",
      "list": [
        {
          "certificate_type": "证书/证件类型1",
          "name": "证件1",
          "issue_agency": "发证机构1",
          "receive_dt": "2016-01-01",
          "valid_start_dt": "2016-01-01",
          "valid_end_dt": "2019-01-01",
          "certificate_number": "A123456789",
          "skill_rank": "一级",
          "skill_profession": "护理专业",
          "recheck_effective_date": "2017-05-01"
        },
        {
          "certificate_type": "证书/证件类型2",
          "name": "证件2",
          "issue_agency": "发证机构2",
          "receive_dt": "2017-01-01",
          "valid_start_dt": "2017-01-01",
          "valid_end_dt": "2020-01-01",
          "certificate_number": "B123456789",
          "skill_rank": "高级",
          "skill_profession": "酒店专精",
          "recheck_effective_date": "2018-05-01"
        }
      ]
    }
  ]
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 返回数据
id 员工id
name 员工名称
list 证书/证件列表
certificate_type 证书/证件类型
name 证书名称
issue_agency 发证机构
receive_dt 发证日期
valid_start_dt 有效期开始日
valid_end_dt 有效期到期日
certificate_number 证书/证件编号
skill_rank 证书/证件级别
skill_profession 证书/证件专业
recheck_effective_date 复审到期日

创建员工的工作经历


使用场景:该接口可用于把员工的工作经历通过开放平台写入到2号。

请求方式:POST(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/work_experience_list/create/?access_token=ACCESS_TOKEN

请求示例:

{
    "employee_id": "c566****-cc7f-****-9192-976e0d69****",
    "work_name": "撒法1",
    "work_start_dt": "2025-02-05",
    "work_duty": "我烦烦烦",
    "work_end_dt": "2025-02-23",
    "referee_tel": "1887895433",
    "referee": "考虑",
    "work_leave_reason": "交换机",
    "work_leave_salary": "45",
    "work_remark": "嘎嘎嘎"
}

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
employee_id String 员工Id
work_name String 工作单位
work_start_dt String 工作开始时间
work_end_dt String 工作结束时间
work_duty String 职务
referee_tel String 证明人联系电话
referee String 证明人
work_leave_reason String 离职原因
work_leave_salary String 离职薪资
work_remark String 工作备注

权限说明

返回结果:

{
    "data": {
        "msg": "添加工作经历成功",
        "id": "fa85****-387c-****-ad63-acb31d5a****"
    },
    "errcode": 0,
    "errmsg": ""
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 返回数据
id 工作经历记录Id

编辑员工的工作经历


使用场景:该接口可用于编辑员工的工作经历。

请求方式:POST(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/work_experience_list/update/?access_token=ACCESS_TOKEN

请求示例:

{
    "id": "fa85****-387c-4fd2-****-acb31d5a****",
    "employee_id": "fa85****-387c-4fd2-****-acb31d5a****",
    "work_name": "撒dgfdgfdgdfgfd法",
    "work_start_dt": "2025-02-05",
    "work_duty": "我",
    "work_end_dt": "2025-02-20",
    "referee_tel": "1887895433",
    "referee": "考虑",
    "work_leave_reason": "交换机",
    "work_leave_salary": "45",
    "work_remark": "嘎嘎嘎"
}

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
id String 工作经历记录Id
employee_id String 员工Id
work_name String 工作单位
work_start_dt String 工作开始时间
work_end_dt String 工作结束时间
work_duty String 职务
referee_tel String 证明人联系电话
referee String 证明人
work_leave_reason String 离职原因
work_leave_salary String 离职薪资
work_remark String 工作备注

权限说明

返回结果:

{
    "data": {
        "msg": "更新工作经历成功"
    },
    "errcode": 0,
    "errmsg": ""
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 返回数据

删除员工的工作经历


使用场景:该接口可用于删除员工的工作经历。

请求方式:POST(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/work_experience_list/delete/?access_token=ACCESS_TOKEN

请求示例:

{
    "id": "db08****-726f-****-930a-33700c67****"
}

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
id String 工作记录Id

权限说明

返回结果:

{
    "data": {
        "msg": "删除工作经历成功"
    },
    "errcode": 0,
    "errmsg": ""
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 返回数据

获取员工的工作经历列表


使用场景:获取员工的工作经历列表。最多一次可获取100个员工。

请求方式:GET(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/work_experience_list/?access_token=ACCESS_TOKEN&ids=IDS

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
ids String 员工id集合,用英文逗号分隔

权限说明

返回结果:

{
  "errcode": 0,
  "errmsg": "",
  "data": [
    {
      "id": "686460*****44f2987db8*****079b89",
      "name": "zhangsan",
      "list": [
        {
          "work_name": "xxx有限公司",
          "work_duty": "销售",
          "work_start_dt": "2015-07",
          "work_end_dt": "2016-10",
          "referee": "xuying",
          "referee_tel": "1590****025",
          "leave_reason": "个人发展",
          "leave_salary": "10000",
          "remark": "备注1"
        },
        {
          "work_name": "xxx有限公司",
          "work_duty": "商务经理",
          "work_start_dt": "2013-05",
          "work_end_dt": "2015-03",
          "referee": "Lily",
          "referee_tel": "1793****334",
          "leave_reason": "个人原因",
          "leave_salary": "15000",
          "remark": "备注2"
        }
      ]
    }
  ]
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 返回数据
id 员工id
name 员工名称
list 工作经历列表
work_name 工作单位
work_duty 职务
work_start_dt 工作开始日期
work_end_dt 工作结束日期
referee 证明人
referee_tel 证明人联系电话
leave_reason 离职原因
leave_salary 离职薪资
remark 工作备注

创建员工的教育经历


使用场景:该接口可用于把员工的教育经历通过开放平台在2号创建

请求方式:POST(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/education_list/create/?access_token=ACCESS_TOKEN

请求示例:

{
    "employee_id":"0ce11441-2a1d-4fe8-b692-d1fdfedfc65b",
    "education":5,
    "school":"北京航空航天大学1",
    "profession":"飞行器设计与工程1",
    "enrollment_dt":"2020-09",
    "graduation_dt":"2024-06",
    "learning_style":1,
    "certificate_no":"10001",
    "degree":1,
    "degree_title":"工学学士学位1",
    "degree_no":"HB-1001-0001",
    "edu_remark":"北京航空航天大学-工学学士学位1"
}

参数说明:

参数 类型 是否必须 说明
employee_id String 员工ID
education Number 学历,枚举值:1-小学,2-初中,3-高中,4-大专,5-本科,6-硕士,7-博士,8-职业高级中学,9-中等专业学校,10-中级技工学校,12-博士后,11-其他,13-中等师范学校,14-高级技工学校
school String 毕业院校
profession String 毕业专业
enrollment_dt String 教育开始时间,年月格式,如:2018-09
graduation_dt String 教育结束时间,年月格式,如:2022-06
learning_style Number 学习形式,枚举值:1-全日制,2-成人教育,3-远程教育,4-自学考试,5-其他非全日制
certificate_no String 毕业证书编号
degree Number 学位类型,枚举值: 1-学士,2-硕士,3-博士,4-名誉博士,5-未取得学位
degree_title String 学位名称
degree_no String 学位证书编号
edu_remark String 教育备注

返回结果:

{
    "errcode": 0,
    "errmsg": "",
    "data": {
        "msg": "添加教育经历成功",
        "id": "0ce11441-2a1d-4fe8-b692-d1fdfedfc65b",
        "is_success": true
    }
}

参数说明:

参数 说明
errcode 返回码 , 0 标识成功
errmsg 对返回码的文本描述内容
data 返回数据
id 记录ID
is_success 操作是否成功:true or false

编辑员工的教育经历


使用场景:该接口可用于编辑员工的教育经历。

请求方式:POST(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/education_list/update/?access_token=ACCESS_TOKEN

请求示例:

{
  "employee_id": "c566****-cc7f-****-9192-976e0d69****",
  "school": "北京大学",
  "degree": 1,
  "profession": "",
  "company_id": "b6d9****-785a-****-a31c-34f3fd7e****",
  "graduation_dt": "2025-12",
  "edu_remark": "哇哇哇哇",
  "enrollment_dt": "2025-06",
  "certificate_no": "12121",
  "degree_title": "北京大学学士",
  "education": 6,
  "id": "7a6b****-243f-****-8330-183729bf****",
  "learning_style": 1,
  "degree_no": "213"
}

参数说明:

参数 类型 是否必须 说明
employee_id String 员工ID
id String 教育经历记录ID
education Integer 学历,枚举值:1-小学,2-初中,3-高中,4-大专,5-本科,6-硕士,7-博士,8-职业高级中学,9-中等专业学校,10-中级技工学校,12-博士后,11-其他,13-中等师范学校,14-高级技工学校
school String 毕业院校
profession String 毕业专业
degree Integer 学位类型,枚举值: 1-学士,2-硕士,3-博士,4-名誉博士,5-未取得学位
graduation_dt String 教育结束时间,年月格式,如:2022-06
edu_remark String 教育备注
enrollment_dt String 教育开始时间,年月格式,如:2018-09
certificate_no String 毕业证书编号
degree_title String 学位名称
learning_style Integer 学习形式,枚举值:1-全日制,2-成人教育,3-远程教育,4-自学考试,5-其他非全日制
degree_no String 学位证书编号

返回结果:

{
    "data": {
        "msg": "更新教育经历成功"
    },
    "errcode": 0,
    "errmsg": ""
}

参数说明:

参数 说明
errcode 返回码 , 0 标识成功
errmsg 对返回码的文本描述内容
data 返回数据

删除员工的教育经历


使用场景:该接口可用于删除员工的教育经历。

请求方式:POST(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/education_list/delete/?access_token=ACCESS_TOKEN

请求示例:

{
  "id": "2121****-960c-****-8d36-4814a7ef****"
}

参数说明:

参数 类型 是否必须 说明
id String 教育经历记录Id

返回结果:

{
    "data": {
        "msg": "删除教育经历成功"
    },
    "errcode": 0,
    "errmsg": ""
}

参数说明:

参数 说明
errcode 返回码 , 0 标识成功
errmsg 对返回码的文本描述内容
data 返回数据

获取员工的教育经历列表


使用场景:获取员工的教育经历列表。最多一次可获取100个员工。

请求方式:GET(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/education_list/?access_token=ACCESS_TOKEN&ids=IDS

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
ids String 员工id集合,用英文逗号分隔

权限说明

返回结果:

{
  "errcode": 0,
  "errmsg": "",
  "data": [
    {
      "id": "686460*****44f2987db8*****079b89",
      "name": "zhangsan",
      "list": [
        {
          "education": 3,
          "degree": 3,
          "degree_title": "硕士",
          "degree_no": "学位证书编号",
          "school": "上海交通大学",
          "profession": "计算机科学与技术",
          "enrollment_dt": "2011-05-03",
          "graduation_dt": "2015-07-05",
          "certificate_no": "8276**********8732",
          "edu_remark": "教育备注",
          "is_primary": 1,
          "learning_style": 1
        }
      ]
    }
  ]
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 返回数据
id 员工id
name 员工名称
list 教育经历列表
education 学历 0:未知;1:小学,2:初中,3:高中,4:大专,5:本科,6:硕士,7:博士,8:职高,9:中专,10:技校,11:其他
degree 学位类型 1:学士;2:硕士;3:博士;4:名誉博士;5:未取得学位;
degree_title 学位名称
degree_no 学位证书编号
school 毕业学校
profession 毕业专业
enrollment_dt 教育开始时间
graduation_dt 教育结束时间
certificate_no 毕业证书编号
edu_remark 教育备注
is_primary 是否最高学历 0:否;1:是
learning_style 学习形式 1:全日制;2:成人教育;3:远程教育;4:自学考试;5:其他非全日制

获取员工的培训经历列表


使用场景:获取员工的培训经历列表。最多一次可获取100个员工。

请求方式:GET(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/training_experience_list/?access_token=ACCESS_TOKEN&ids=IDS

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
ids String 员工id集合,用英文逗号分隔

权限说明

返回结果:

{
  "errcode": 0,
  "errmsg": "",
  "data": [
    {
      "id": "686460*****44f2987db8*****079b89",
      "name": "zhangsan",
      "list": [
        {
          "training_name": "专业技能培训",
          "training_institution": "专业技能培训单位",
          "training_certificate": "专业技能培训证书",
          "training_date": "2017-06-06",
          "training_start_dt": "2017-06-06",
          "training_end_dt": "2019-06-06",
          "training_total_time": "120",
          "training_grade": "100",
          "training_certificate_no": "A123456789",
          "remark": "备注"
        },
        {
          "training_name": "急救技能培训",
          "training_institution": "急救技能培训单位",
          "training_certificate": "急救技能培训证书",
          "training_date": "2016-12-01",
          "training_start_dt": "2016-12-01",
          "training_end_dt": "2019-12-01",
          "training_total_time": "300",
          "training_grade": "A",
          "training_certificate_no": "B123456789",
          "remark": "备注"
        }
      ]
    }
  ]
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 返回数据
id 员工id
name 员工名称
list 培训经历列表
training_name 培训名称
training_institution 培训单位
training_certificate 培训证书名称
training_date 培训时间
training_start_dt 培训开始时间
training_end_dt 培训结束时间
training_total_time 培训总学时(单位:小时)
training_grade 培训成绩
training_certificate_no 培训证书编号
remark 培训备注

创建员工的合同记录


使用场景:该接口可用于把员工的合同记录通过开放平台写入到2号

请求方式:POST(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/contract_list/create/?access_token=ACCESS_TOKEN

请求示例:

{
    "employee_id": "c65ee22d-5f99-4a36-8abf-3fda0f8fb6fd",
    "contract_type": 1,
    "contract_start_dt": "2016-01-01",
    "remark": "备注信息",
    "contract_no": "D76358",
    "contract_sign_dt": "2016-01-02",
    "contract_end_dt": "2017-01-01",
    "is_without_end_dt": false,
    "contract_type_text": "劳动合同类型",
    "contract_company_name": "2号人事部",
    "contract_company_id": "c65ee22d-5f99-4a36-8abf-3fda0f8fb6fd",
    "company_contract_type_id": "c65ee22d-5f99-4a36-8abf-3fda0f8fb6fd",
    "contract_type_title": "劳动合同名称",
    "is_remind": false,
    "status": 0
}

参数说明:

参数 类型 是否必须 说明
employee_id String 员工ID
remark String 备注
contract_no String 合同编号
contract_type Number 合同类型
contract_start_dt String 合同开始时期
contract_sign_dt String 合同签订时期
contract_end_dt String 合同结束时期
is_without_end_dt Boolean 是否无固定期限
contract_type_text String 合同类型文本
contract_company_name String 合同公司名称
contract_company_id String 合同公司ID
company_contract_type_id String 合同类型id
contract_type_title String 合同类型名称
is_remind Boolean 是否需要合同到期提醒
status Number 状态 0-执行中 2-已到期 3-未执行

注意:

权限说明

返回结果:

{
  "errcode": 0,
  "errmsg": "",
  "data": {
    "is_success": true,
    "id": "c65ee22d-5f99-4a36-8abf-3fda0f8fb6fd"
  }
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 返回数据
is_success 操作是否成功:true or false
id 创建的记录id

编辑员工的合同记录


使用场景:该接口可用于编辑员工的合同记录。

请求方式:POST(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/contract_list/update/?access_token=ACCESS_TOKEN

请求示例:

{
  "employee_id": "c566****-cc7f-****-9192-976e0d69****",
  "remark": "烦烦烦",
  "contract_no": "55933356",
  "contract_type": 1,
  "contract_start_dt": "2025-02-12",
  "contract_sign_dt": "2025-02-12",
  "contract_end_dt": "2026-02-12",
  "is_without_end_dt": false,
  "contract_type_text": "",
  "contract_company_name": "腾讯科技(深圳)有限公司",
  "contract_company_id": "e7df****-9af9-****-881d-9a6d8773****",
  "company_contract_type_id": "ac53****-d60b-****-b426-53a6e6e7****",
  "contract_type_title": "固定期限劳动合同",
  "is_remind": true,
  "status": 0,
  "id": "c65c****-9d45-****-9a9d-3f1a588c****"
}

参数说明:

参数 类型 是否必须 说明
id String 合同记录ID
employee_id String 员工ID
company_contract_type_id String 合同类型ID
contract_type_title String 合同类型名称
contract_type Integer 合同类型(1: 固定期限劳动合同, 2: 实习协议, 3: 劳务合同, 4: 无固定期限劳动合同, 5: 劳务派遣合同, 6: 返聘协议, 7: 以完成一定工作任务为期限的劳动合同, 99: 其他, 100: 自定义合同类型)
contract_type_text String 合同类型文本
contract_no String 合同编号
status String 合同状态 (0: 执行中, 2: 已到期, 3: 未执行)
remark String 合同备注
is_without_end_dt Boolean 是否无固定期限
contract_company_id String 合同公司ID
contract_company_name String 合同公司名称
contract_sign_dt String 合同签订日期, 年月日格式, 如: 2018-09-01
is_remind Boolean 是否合同到期提醒
contract_start_dt String 合同开始时间, 年月日格式, 如: 2018-09-01
contract_end_dt String 合同结束时间, 年月日格式, 如: 2018-09-01

权限说明

返回结果:

{
    "data": {
        "msg": "更新合同信息成功"
    },
    "errcode": 0,
    "errmsg": ""
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 返回数据

删除员工的合同记录


使用场景:该接口可用于删除员工的合同记录

请求方式:POST(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/contract_list/delete/?access_token=ACCESS_TOKEN

请求示例:

{
  "id": "c65c****-9d45-****-9a9d-3f1a588c****"
}

参数说明:

参数 类型 是否必须 说明
id String 合同记录Id

注意:

权限说明

返回结果:

{
    "data": {
        "msg": "删除合同信息成功"
    },
    "errcode": 0,
    "errmsg": ""
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 返回数据

获取员工的合同记录列表


使用场景:获取员工的有效合同记录列表。最多一次可获取100个员工。

请求方式:GET(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/contract_list/?access_token=ACCESS_TOKEN&ids=IDS

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
ids String 员工id集合,用英文逗号分隔

权限说明

返回结果:

{
  "errcode": 0,
  "errmsg": "",
  "data": [
    {
      "id": "686460*****44f2987db8*****079b89",
      "name": "zhangsan",
      "list": [
        {
          "contract_no": "D76358",
          "contract_type": 2,
          "contract_start_dt": "2016-01-01",
          "contract_end_dt": "2016-06-30",
          "contract_sign_dt": "2015-12-19",
          "terminate_dt": "2015-12-19",
          "contract_company_name": "2号人事部",
          "contract_company_id": "ec9562*****a4c99b6275*****13a2fc",
          "contract_period": "1年",
          "contract_status": 1,
          "contract_id": "ec9562*****a4c99b6275*****13a2fc",
          "remark": "备注"
        },
        {
          "contract_no": "E91287",
          "contract_type": 1,
          "contract_start_dt": "2016-11-29",
          "contract_end_dt": "2017-11-28",
          "contract_sign_dt": "2016-11-19",
          "terminate_dt": null,
          "contract_company_name": "2号人事部",
          "contract_company_id": "ec9562*****a4c99b6275*****13a2fc",
          "contract_period": "1年",
          "contract_status": 0,
          "contract_id": "e34100*****842bf8b2ac*****560ee7",
          "remark": "备注"
        }
      ]
    }
  ]
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 返回数据
id 员工id
name 员工名称
list 合同列表
contract_no 合同编号
contract_type 合同类型 1: 固定期限劳动合同; 2: 实习协议; 3: 劳务合同; 4: 无固定期限劳动合同; 5: 劳务派遣合同; 6: 返聘协议; 7: 以完成一定工作任务为期限的劳动合同; 8: 借调合同; 99: 其他合同及协议;
contract_start_dt 开始日期
contract_end_dt 结束日期
contract_sign_dt 合同签订日期
contract_company_name 合同公司
contract_company_id 合同公司id
contract_period 合同期限 (合同期限=结束日期-开始日期计算得出,为整年时单位为年,为整月时单位为月,其余单位为天)
contract_status 合同状态 0:执行中;1:已解除;2:已到期;3:未执行;
contract_id 合同id
remark 合同备注
terminate_dt 解除日期

创建员工的紧急联系人


使用场景:该接口可用于把员工的紧急联系人通过开放平台写入到2号

请求方式:POST(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/contact_list/create/?access_token=ACCESS_TOKEN

请求示例:

{
    "contact_name": "张三",
    "contact_relationship": "朋友",
    "contact_phone": "13888888888",
    "contact_address": "国人通信大厦B602",
    "contact_is_primary": 1,
    "employee_id": "0ce11441-2a1d-4fe8-b692-d1fdfedfc65b"
}

参数说明:

参数 类型 是否必须 说明
employee_id String 员工ID
contact_name String 联系人姓名
contact_relationship String 关系
contact_phone String 联系人电话
contact_address String 联系人地址
contact_is_primary Number 是否为主要联系人,1是 0否

返回结果:

{
    "errcode": 0,
    "errmsg": "",
    "data": {
        "msg": "添加紧急联系人成功",
        "is_success": true,
        "id": "0774b4e0-91c6-4cf6-93e9-dcb40441871e"
    }
}

参数说明:

参数 说明
errcode 返回码 , 0 标识成功
errmsg 对返回码的文本描述内容
data 返回数据
id 记录ID
is_success 操作是否成功:true or false

获取员工的紧急联系人列表


使用场景:获取员工的紧急联系人列表。最多一次可获取100个员工。

请求方式:GET(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/contact_list/?access_token=ACCESS_TOKEN&ids=IDS

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
ids String 员工id集合,用英文逗号分隔

权限说明

返回结果:

{
  "errcode": 0,
  "errmsg": "",
  "data": [
    {
      "id": "686460*****44f2987db8*****079b89",
      "name": "zhangsan",
      "list": [
        {
          "contact_name": "李四",
          "is_primary": 1,
          "contact_relationship": "父亲",
          "contact_phone": "186****7648",
          "contact_address": "广东省深圳市南山区****"
        },
        {
          "contact_name": "王洁",
          "is_primary": 0,
          "contact_relationship": "母亲",
          "contact_phone": "135****3589",
          "contact_address": "广东省深圳市南山区****"
        }
      ]
    }
  ]
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 返回数据
id 员工id
name 员工名称
list 紧急联系人列表
contact_name 联系人姓名
is_primary 是否为主要联系人 0:否;1:是
contact_relationship 联系人关系
contact_phone 联系人电话
contact_address 联系人地址

获取员工的语言能力列表


使用场景:获取员工的语言能力列表。最多一次可获取100个员工。

请求方式:GET(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/language_list/?access_token=ACCESS_TOKEN&ids=IDS

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
ids String 员工id集合,用英文逗号分隔

权限说明

返回结果:

{
  "errcode": 0,
  "errmsg": "",
  "data": [
    {
      "id": "686460*****44f2987db8*****079b89",
      "name": "zhangsan",
      "list": [
        {
          "name": "英语",
          "degree": 4,
          "remark": "备注"
        },
        {
          "name": "法语",
          "degree": 1,
          "remark": "备注"
        }
      ]
    }
  ]
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 返回数据
id 员工id
name 员工名称
list 语言能力列表
name 语种
degree 掌握程度 1:一般;2:良好;3:熟练;4:精通
remark 语言备注

获取员工的家庭成员列表


使用场景:获取员工的家庭成员列表。最多一次可获取100个员工。

请求方式:GET(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/family_list/?access_token=ACCESS_TOKEN&ids=IDS

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
ids String 员工id集合,用英文逗号分隔

权限说明

返回结果:

{
  "errcode": 0,
  "errmsg": "",
  "data": [
    {
      "id": "686460*****44f2987db8*****079b89",
      "name": "zhangsan",
      "list": [
        {
          "name": "张华",
          "relation": "父亲",
          "work_company": "点米科技",
          "work_job_title": "程序员",
          "birthday": "1975-05-23",
          "mobile": "186****7458",
          "relative_education": 1
        },
        {
          "name": "李敏",
          "relation": "母亲",
          "work_company": "易博三茅",
          "work_job_title": "销售",
          "birthday": "1976-01-12",
          "mobile": "135****4589",
          "relative_education": 2
        }
      ]
    }
  ]
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 返回数据
id 员工id
name 员工名称
list 证书列表
name 成员姓名
relation 关系
work_company 工作单位
work_job_title 任职职位
birthday 出生年月
mobile 成员电话
relative_education 成员文化程度 0:未知;1:小学,2:初中,3:高中,4:大专,5:本科,6:硕士,7:博士,8:职高,9:中专,10:技校,11:其他

获取员工的工作技能列表


使用场景:获取员工的工作技能列表。最多一次可获取100个员工。

请求方式:GET(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/work_skill_list/?access_token=ACCESS_TOKEN&ids=IDS

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
ids String 员工id集合,用英文逗号分隔

权限说明

返回结果:

{
  "errcode": 0,
  "errmsg": "",
  "data": [
    {
      "id": "686460*****44f2987db8*****079b89",
      "name": "zhangsan",
      "list": [
        {
          "name": "Python",
          "degree": 4,
          "remark": "备注"
        },
        {
          "name": "Sql",
          "degree": 2,
          "remark": "备注"
        }
      ]
    }
  ]
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 返回数据
id 员工id
name 员工名称
list 技能列表
name 技能名称
degree 掌握程度 1:一般;2:良好;3:熟练;4:精通
remark 技能备注

获取员工的任职记录列表


使用场景:获取员工的任职记录列表。最多一次可获取100个员工。

请求方式:GET(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/career_list/?access_token=ACCESS_TOKEN&ids=IDS

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
ids String 员工id集合,用英文逗号分隔

权限说明

返回结果:

{
  "errcode": 0,
  "errmsg": "",
  "data": [
    {
      "id": "686460*****44f2987db8*****079b89",
      "name": "zhangsan",
      "list": [
        {
          "career_id": "f05e1899-51fe-4775-8d09-f1f8b404ccb4",
          "start_dt": "2018-03-01",
          "end_dt": "2019-03-01",
          "department_id": "689555*****a-4c24-a00*****6b336a56",
          "department_name": "技术部",
          "job_position_id": "d0f95b*****b-4930-83*****a64b18186",
          "job_position_name": "前端程序员",
          "job_level_name": "b1",
          "contract_company_name": "深圳市**科技",
          "work_place_name": "广东省深圳市",
          "remark": "备注",
          "report_leader_name": "刘欢",
          "record_type": 1
        },
        {
          "career_id": "ee82ec69-d497-48f3-b577-b4d4681ea765",
          "start_dt": "2016-03-01",
          "end_dt": "2018-01-01",
          "department_id": "689555*****a-4c24-a00*****6b336a56",
          "department_name": "开发部",
          "job_position_id": "d0f95b*****b-4930-83*****a64b18186",
          "job_position_name": "前端程序员",
          "job_level_name": "b3",
          "contract_company_name": "广州市**科技",
          "work_place_name": "广东省广州市",
          "remark": "备注",
          "report_leader_name": "刘欢",
          "record_type": 2
        }
      ]
    }
  ]
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 返回数据
id 员工id
name 员工名称
list 任职记录列表
career_id 任职记录ID
start_dt 任职开始日期
end_dt 任职结束日期
department_id 组织ID
department_name 组织(文本)
job_position_id  岗位ID
job_position_name 岗位(文本)
job_level_name 职级(文本)
contract_company_name 合同公司(文本)
work_place_name 工作地点(文本)
remark 任职备注
report_leader_name 汇报上级
record_type 任职记录类型: 1 普通记录 2 兼任部门记录

创建员工的任职记录


使用场景:该接口用于把员工的任职记录通过开放平台写入到2号。

请求方式:POST(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/career_create/?access_token=ACCESS_TOKEN

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
employee_id String 员工id
start_dt String 任职开始日期
end_dt String 任职结束日期
dep_id String 部门id
dep_name String 部门(非全称)
job_title_id String 岗位id
job_title_name String 岗位
report_leader_name String 汇报上级,汇报上级不能多于150字
job_position_id String 职务id
job_position_name String 职务
job_level_id String 职级id
job_level_name String 职级
work_type Number 工作性质 0:全职;1:兼职;2:实习生;3:退休返聘;4:劳务派遣;5:外包;6:劳务;7:派遣;8:小时工;9:临时工;10:社会兼职;11:学生兼职;12:借调;99:其他;
contract_company_id String 合同公司id
contract_company_name String 合同公司
work_place_id String 工作地点id
work_place_name String 工作地点
remark String 任职备注,任职备注不能多于200字

返回结果:

{
    "data": {
        "msg": "创建任职记录成功"
    },
    "errcode": 0,
    "errmsg": ""
}

参数说明:

参数 说明
data 返回数据
errcode 返回码
errmsg 对返回码的文本描述内容

编辑员工的任职记录


使用场景:该接口可用于编辑员工的任职记录。

请求方式:POST(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/career_update/?access_token=ACCESS_TOKEN

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
id String 任职记录id
employee_id String 员工id
start_dt String 任职开始日期
end_dt String 任职结束日期
dep_id String 部门id
dep_name String 部门(非全称)
job_title_id String 岗位id
job_title_name String 岗位
report_leader_name String 汇报上级,汇报上级不能多于150字
job_position_id String 职务id
job_position_name String 职务
job_level_id String 职级id
job_level_name String 职级
work_type Number 工作性质 0:全职;1:兼职;2:实习生;3:退休返聘;4:劳务派遣;5:外包;6:劳务;7:派遣;8:小时工;9:临时工;10:社会兼职;11:学生兼职;12:借调;99:其他;
contract_company_id String 合同公司id
contract_company_name String 合同公司
work_place_id String 工作地点id
work_place_name String 工作地点
remark String 任职备注,任职备注不能多于200字

返回结果:

{
    "data": {
        "msg": "修改任职记录成功"
    },
    "errcode": 0,
    "errmsg": ""
}

参数说明:

参数 说明
data 返回数据
errcode 返回码
errmsg 对返回码的文本描述内容

删除员工的任职记录


使用场景:该接口可用于删除员工的任职记录。

请求方式:POST(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/career_delete/?access_token=ACCESS_TOKEN

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
id String 任职记录id

返回结果:

{
    "data": {
        "msg": "删除任职记录成功"
    },
    "errcode": 0,
    "errmsg": ""
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 返回数据

获取员工的奖惩记录列表


使用场景:获取员工的奖惩记录列表。最多一次可获取100个员工。

请求方式:GET(HTTPS)

请求地址:https://openapi.2haohr.com/api/employees/award_list/?access_token=ACCESS_TOKEN&ids=IDS

参数说明:

参数 类型 是否必须 说明
access_token String 调用接口凭证
ids String 员工id集合,用英文逗号分隔

权限说明

返回结果:

{
  "errcode": 0,
  "errmsg": "",
  "data": [
    {
      "id": "686460*****44f2987db8*****079b89",
      "name": "zhangsan",
      "list": [
        {
          "award_type": 1,
          "award_tag": "年度优秀员工奖",
          "award_dt": "2019-02-28",
          "amount": "10000",
          "reason": "表现优秀",
          "name": "现金奖励",
          "remark": "当场发放"
        },
        {
          "award_type": 2,
          "award_tag": "口头警告",
          "award_dt": "2017-05-06",
          "amount": "0",
          "reason": "迟到",
          "name": "批评教育",
          "remark": "已完成"
        }
      ]
    }
  ]
}

参数说明:

参数 说明
errcode 返回码
errmsg 对返回码的文本描述内容
data 返回数据
id 员工id
name 员工名称
list 奖惩记录列表
award_type 奖惩类型 1:奖励;2:惩罚
award_tag 奖惩类别
award_dt 奖惩日期
amount 奖惩金额
reason 奖惩原因
name 奖惩内容
remark 奖惩备注

新增员工 - 和用户流程绑定


使用场景:通过该接口,将新增2号员工信息,并且和用户流程entry_id建立绑定关系

请求方式: POST(HTTPS)

请求地址: https://openapi.2haohr.com/api/employees/entry_employee_create/?access_token=ACCESS_TOKEN

请求参数

参数 类型 是否必填 参数说明
access_token String 调用接口凭证
entry_id String 用户流程ID
emp_name String 员工姓名
english_name String 英文名
sex Number 性别 0:未知;1:男;2:女
mobile String 手机号码
email String 个人邮箱
credentials_type Number 证件类型(默认为1) 1:身份证 2:外国护照 5:台湾居民来往大陆通行证 6:港澳居民来往内地通行证 7:其他 8:香港身份证 9:台湾身份证 10:澳门身份证 11:外国人永久居留证
credentials_no String 证件号码
hire_date String 入职时间(默认为当天)
probation Number 试用期(null:未设置,0:无试用期,1~12:表示N个月,15~90:表示N天)
contract_company_name String 合同公司
dept_name String 组织全称(以斜杠'/'分隔)
job_position_name String 职务
job_title_name String 岗位
job_level_name String 职级
work_type Number 工作性质: 0:全职;1:兼职;2:实习生;3:退休返聘;4:劳务派遣;5:外包;6:劳务;7:派遣;8:小时工;9:临时工;10:社会兼职;11:学生兼职;12:借调;99:其他;
work_status Number 员工状态: 1: 试用期 2: 正式
emp_no String 工号
work_place_name String 工作地点
work_city_name String 工作城市
work_email String 工作邮箱
emp_oa_code String 员工OA编码
report_leader_id String 汇报上级id
report_leader_name String 汇报上级名称
first_work_date String 参加工作时间
wage_card_no String 工资卡卡号
bank_city_name String 工资卡开户城市
bank String 工资卡开户行

注意: 合同公司默认为access_token信息所属的公司

返回结果

{
    "data": {
        "job_position_name": null,
        "sex": 0,
        "job_title_name": "",
        "work_status": 1,
        "work_city_name": null,
        "english_name": "",
        "probation": 0,
        "id": "ec8e7c*****f453b9fca8*****9dba19",
        "dept_name": "互联网产品部/技术中心/后端一组",
        "work_place_name": "",
        "emp_oa_code": "",
        "email": "",
        "job_level_name": "",
        "work_type": 0,
        "contract_company_name": "冰霜之境",
        "credentials_type": 1,
        "emp_name": "刘能",
        "work_email": "",
        "credentials_no": "",
        "emp_no": "",
        "mobile": "",
        "hire_date": "2019-06-16",
        "report_leader_id": "",
        "report_leader_name": "",
        "first_work_date": "2011-11-11",
        "wage_card_no": "",
        "bank_city_name": "四川/德阳/中江县",
        "bank": "中信银行南山支行"
    },
    "errcode": 0,
    "errmsg": "",
}