组织信息¶
获取组织列表¶
使用场景:该接口用于获取指定组织及其下的子组织信息,包括组织名称、编码、子组织、父组织、组织负责人等。
请求方式:GET(HTTPS)
请求地址:https://openapi.2haohr.com/api/departments/?access_token=ACCESS_TOKEN
参数说明:
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
| id | String | 否 | 组织id。获取指定组织及其下的子组织。 如果不填,默认获取全量组织架构 |
权限说明
返回结果:
{
"errcode": 0,
"errmsg": "",
"data": [
{
"id": "d22ba6*****f44c7a89ae*****19c7f5",
"name": "研发部",
"serial_no": "1212",
"category": 2,
"order": 12,
"parentid": null,
"parent_serial_no": null,
"leader_id": "a149cc*****14b32990c8*****b420ef",
"leader_name": "王付",
"leader_emp_no": "no010",
"branch_leader_id": "b87939*****74563a6214*****1fbe27",
"branch_leader_name": "张达",
"branch_leader_emp_no": "no003",
"dept_oa_code": "10006440",
"short_name": "研发",
"ability": "研究发明",
"manning": 998,
"description": "这里有一段描述",
"open_date": "2021-06-01",
"status": 2,
"children": [
{
"id": "8eb553*****d4db2a40ff*****b7138d",
"name": "视觉规划部",
"serial_no": "121",
"category": 2,
"order": 1,
"parentid": "d22ba6*****f44c7a89ae*****19c7f5",
"parent_serial_no": "1212",
"leader_id": "90a016*****044e991712*****95278d",
"leader_name": "刘觉",
"leader_emp_no": "no012",
"branch_leader_id": "b87939*****74563a6214*****1fbe27",
"branch_leader_name": "张达",
"branch_leader_emp_no": "no003",
"dept_oa_code": "10006441",
"short_name": "研发",
"ability": "研究发明",
"manning": 998,
"description": "这里有一段描述",
"open_date": "2021-06-01",
"status": 2,
"children": [
{
"id": "e20dc4*****a4d8da82cb*****8e054c",
"name": "设计组",
"serial_no": "122",
"category": 2,
"order": 5,
"parentid": "8eb553*****d4db2a40ff*****b7138d",
"parent_serial_no": "1212",
"leader_id": "f74c27*****6420f97607*****bfc6a5",
"leader_name": "李斯",
"leader_emp_no": "no102",
"dept_oa_code": "10006442",
"branch_leader_id": "b87939*****74563a6214*****1fbe27",
"branch_leader_name": "张达",
"branch_leader_emp_no": "no003",
"short_name": "研发",
"ability": "研究发明",
"manning": null,
"description": "这里有一段描述",
"open_date": "2021-06-11",
"status": 2
}
]
}
]
},
{
"id": "7cba10*****a4c0b9b143*****a577ea",
"name": "总裁部",
"serial_no": "1213",
"category": 2,
"order": 13,
"parentid": null,
"parent_serial_no": null,
"leader_id": "fb90fe****1409885176****a1785f",
"leader_name": "张锋",
"leader_name_emp_no": "no030",
"dept_oa_code": "10006443",
"branch_leader_id": "b87939*****74563a6214*****1fbe27",
"branch_leader_name": "张达",
"branch_leader_emp_no": "no003",
"short_name": "研发",
"ability": "研究发明",
"manning": null,
"description": "这里有一段描述",
"open_date": "2021-06-11",
"status": 2
}
]
}
参数说明:
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| data | 返回数据 |
| id | 组织id |
| name | 组织名称 |
| serial_no | 组织编码 |
| parentid | 父组织id |
| parent_serial_no | 父组织编码 |
| order | 在父组织中的次序值 |
| children | 子级组织 |
| leader_id | 负责人id |
| leader_name | 负责人 |
| leader_emp_no | 负责人工号 |
| dept_oa_code | 组织OA编码 |
| branch_leader_id | 分管领导id |
| branch_leader_name | 分管领导 |
| branch_leader_emp_no | 分管领导工号 |
| category | 组织类型(1-公司, 2-部门, 3-业务实体) |
| short_name | 组织简称 |
| ability | 组织职能 |
| manning | 编制人数 |
| open_date | 启用日期 |
| description | 组织描述 |
| status | 组织状态(2-启用, 3-停用) |
获取组织详情¶
使用场景:该接口用于获取指定组织详情信息,包括组织名称、编码、组织负责人等。
请求方式:GET(HTTPS)
请求地址:https://openapi.2haohr.com/api/departments/{id}/?access_token=ACCESS_TOKEN
参数说明:
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
| id | String | 是 | 组织id |
权限说明
返回结果:
{
"errcode": 0,
"errmsg": "",
"data": {
"id": "7cba10*****a4c0b9b143*****a577ea",
"name": "技术开发部",
"serial_no": "1212",
"category": 2,
"order": 10,
"parent_serial_no": null,
"parentid": null,
"leader_id": "9a272d*****a48ea89240*****3111de",
"leader_name": "王五",
"leader_emp_no": "no102",
"dept_oa_code": "10006443",
"branch_leader_id": "8e84f3*****9401a9ae6b*****ea2b2b",
"branch_leader_name": "李思",
"branch_leader_emp_no": "no020",
"short_name": "研发",
"ability": "研究发明",
"manning": 998,
"description": "这里有一段描述",
"open_date": "2021-06-01",
"status": 2,
"children": [{
"id": "2c6f7a*****d4a899a5ea*****385196",
"name": "前端开发",
"serial_no": "121",
"category": 2,
"order": 1,
"parent_serial_no": "1212",
"parentid": "7cba10*****a4c0b9b143*****a577ea",
"leader_id": "0d0e49*****b461693986*****fda983",
"leader_name": "刘能",
"leader_emp_no": "no214",
"dept_oa_code": "10006444",
"branch_leader_id": "8e84f33c-8f29-401a-9ae6-bb4dffea2b2b",
"branch_leader_name": "李思",
"branch_leader_emp_no": "no020",
"short_name": "研发",
"ability": "研究发明",
"manning": null,
"description": "这里有一段描述",
"open_date": "2021-06-11",
"status": 2
}
]
}
}
参数说明:
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| data | 返回数据 |
| id | 组织id |
| name | 组织名称 |
| serial_no | 组织编码 |
| order | 在父组织中的次序值 |
| parent_serial_no | 父组织编码 |
| parentid | 父亲组织id |
| children | 子级组织列表 |
| leader_id | 负责人id |
| leader_name | 负责人 |
| leader_emp_no | 负责人工号 |
| dept_oa_code | 组织OA编码 |
| branch_leader_id | 分管领导id |
| branch_leader_name | 分管领导 |
| branch_leader_emp_no | 分管领导工号 |
| category | 组织类型(1-公司, 2-部门, 3-业务实体) |
| short_name | 组织简称 |
| ability | 组织职能 |
| manning | 编制人数 |
| open_date | 启用日期 |
| description | 组织描述 |
| status | 组织状态(2-启用, 3-停用) |
查找组织¶
使用场景:通过组织名称、组织代码,获取组织id等基本信息。
请求方式:GET(HTTPS)
请求地址:https://openapi.2haohr.com/api/departments/search_dept/?access_token=ACCESS_TOKEN
参数说明:
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
| keyword | String | 否 | 查找关键字(组织名称、组织代码) |
| limit | String | 否 | 每页返回数据量 |
| p | String | 否 | 页码 |
说明:
权限说明
返回结果
{
"data": {
"p": 1,
"limit": 20,
"offset": 0,
"total_count": 3,
"totalpage": 1,
"objects": [
{
"status": 2,
"leader_id": "6bbb****-5367-****-b287-50f5837e****",
"serial_no": "",
"manning": null,
"branch_leader_emp_no": "",
"id": "1e4c****-8a56-****-a2c0-01ad0476****",
"ability": null,
"category": 2,
"branch_leader_id": null,
"leader_name": "ZI HQY",
"open_date": "2020-06-03",
"sort": 1,
"dept_oa_code": "",
"description": null,
"short_name": "",
"leader_emp_no": "",
"parent_serial_no": null,
"branch_leader_name": null,
"parentid": null,
"sup_department_id": null,
"name": "11",
"level": 1
},
{
"status": 2,
"leader_id": "f94b****-fd86-****-bd8a-15814c22****",
"serial_no": "",
"manning": null,
"branch_leader_emp_no": "",
"id": "992c****-6066-****-8579-c502146a****",
"ability": null,
"category": 2,
"branch_leader_id": null,
"leader_name": "刘小仁",
"open_date": "2020-10-10",
"sort": 2,
"dept_oa_code": "",
"description": null,
"short_name": "",
"leader_emp_no": "1243443",
"parent_serial_no": "",
"branch_leader_name": null,
"parentid": "1e4c****-8a56-****-a2c0-01ad0476****",
"sup_department_id": "1e4c****-8a56-****-a2c0-01ad0476****",
"name": "111",
"level": 2
}
]
},
"errcode": 0,
"errmsg": ""
}
参数说明:
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对返回码的文本描述内容 |
| data | 返回数据 |
| object | 返回主体数据 |
| p | 页码,默认1 |
| limit | 每页返回数据量,默认20 |
| offset | 偏移量 |
| total_count | 返回总数量 |
| totalpage | 总页数 |
| id | 组织ID |
| status | 状态 |
| leader_id | 负责人ID |
| serial_no | 组织编码 |
| manning | 编制人数 |
| branch_leader_emp_no | 分管领导工号 |
| ability | 组织职能 |
| category | 组织类型(1-公司, 2-部门, 3-业务实体) |
| branch_leader_id | 分管领导ID |
| leader_name | 负责人 |
| open_date | 启用日期 |
| sort | 在父组织中的次序值 |
| dept_oa_code | 组织OA编码 |
| description | 组织描述 |
| short_name | 组织简称 |
| leader_emp_no | 负责人工号 |
| parent_serial_no | 父组织编码 |
| branch_leader_name | 分管领导 |
| parentid | 父组织Id |
| sup_department_id | 上级部门Id |
| name | 组织名称 |
| level | 组织层级 |
新增组织¶
使用场景:该接口可用于写入组织信息到2号,如在企业OA中新增了组织信息后,同步写入到2号中。。
请求方式:POST(HTTPS)
请求地址:https://openapi.2haohr.com/api/departments/create/?access_token=ACCESS_TOKEN
参数说明:
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
| dept_name | String | 是 | 组织名称 |
| dept_type | Number | 否 | 组织类型(1-公司/2-部门/3-业务实体 更多参考2号启用的组织类型)(默认为部门) |
| dept_oa_code | String | 否 | 组织OA编码 |
| is_virtual | Boolean | 否 | 是否虚拟组织(默认为否) |
| parent_dept_id | String | 否 | 上级组织 |
| parent_dept_name | String | 否 | 上级组织全称(以斜杠'/'分隔) |
| dept_leader_id | String | 否 | 组织负责人ID |
| dept_leader_name | String | 否 | 组织负责人 |
| open_date | String | 否 | 启用日期 |
| serial_no | String | 否 | 组织代码 |
| short_name | String | 否 | 组织简称 |
| dept_branch_leader_id | String | 否 | 组织分管领导ID |
| dept_branch_leader_name | String | 否 | 组织分管领导 |
| description | String | 否 | 组织描述 |
| ability | String | 否 | 组织职能 |
| manning | Number | 否 | 编制人数 |
组织添加最大层级为8级
权限说明
返回结果
{
"errcode": 0,
"errmsg": "",
"data": {
"id": "7cba10*****a4c0b9b143*****a577ea",
"dept_name": "后端一组",
"dept_type": 2,
"dept_oa_code": "",
"is_virtual": false,
"parent_dept_id": "9a272d*****a48ea89240*****3111de",
"parent_dept_name": "研发中心/技术研发/后端开发",
"dept_leader_id": "8e84f3*****9401a9ae6b*****ea2b2b",
"dept_leader_name": "李刚",
"open_date": "2019-06-16",
"serial_no": "",
"short_name": "后一",
"dept_branch_leader_id": "8e84f3*****9401a9ae6b*****ea2b2b",
"dept_branch_leader_name": "李刚",
"description": "不能告人的描述",
"ability": "你的职能",
"manning": 998
}
}
编辑组织¶
使用场景:该接口可用于修改2号组织信息,如在企业OA中修改了组织信息后,同步更新到2号中。
请求方式:POST(HTTPS)
请求地址:https://openapi.2haohr.com/api/departments/update/?access_token=ACCESS_TOKEN
参数说明:
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
| id | String | 是 | 组织id |
| dept_name | String | 是 | 组织名称 |
| dept_type | Number | 否 | 组织类型(1-公司/2-部门/3-业务实体 更多参考2号启用的组织类型) |
| dept_oa_code | String | 否 | 组织OA编码 |
| is_virtual | Boolean | 否 | 是否虚拟组织 |
| parent_dept_id | String | 否 | 上级组织 |
| parent_dept_name | String | 否 | 上级组织全称(以斜杠'/'分割) |
| dept_leader_id | String | 否 | 组织负责人ID |
| dept_leader_name | String | 否 | 组织负责人 |
| open_date | String | 否 | 启用日期 |
| serial_no | String | 否 | 组织代码 |
| short_name | String | 否 | 组织简称 |
| dept_branch_leader_id | String | 否 | 组织分管领导ID |
| dept_branch_leader_name | String | 否 | 组织分管领导 |
| description | String | 否 | 组织描述 |
| ability | String | 否 | 组织职能 |
| manning | Number | 否 | 编制人数 |
返回结果
{
"errcode": 0,
"errmsg": "",
"data": {
"id": "7cba10*****a4c0b9b143*****a577ea",
"dept_name": "后端一组",
"dept_type": 2,
"dept_oa_code": "001123",
"is_virtual": false,
"parent_dept_id": "9a272d*****a48ea89240*****3111de",
"parent_dept_name": "研发中心/技术研发/后端开发",
"dept_leader_id": "8e84f3*****9401a9ae6b*****ea2b2b",
"dept_leader_name": "李刚",
"open_date": "2019-06-16",
"serial_no": "",
"short_name": "后一",
"dept_branch_leader_id": "8e84f3*****9401a9ae6b*****ea2b2b",
"dept_branch_leader_name": "李刚",
"description": "不能告人的描述",
"ability": "你的职能",
"manning": 998
}
}
删除组织¶
使用场景:该接口可用于删除2号组织信息,如在企业OA中删除了组织信息后,同步更新到2号中。
请求方式:POST(HTTPS)
请求地址:https://openapi.2haohr.com/api/departments/delete/?access_token=ACCESS_TOKEN
请求示例:
{
"id": "xxxxxx"
}
参数说明:
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| id | String | 是 | 组织id |
返回结果
{
"errcode": 0,
"errmsg": "",
"data": {
"is_success": true,
"msg": ""
}
}
启用组织¶
使用场景:该接口可用于启用2号的组织。
请求方式:POST(HTTPS)
请求地址:https://openapi.2haohr.com/api/departments/dept_date_reopen/?access_token=ACCESS_TOKEN
请求示例:
{
"id": "d3d0****-5116-****-a79d-1dc1ff8d****",
"name": "大撒大撒大大",
"short_name": "飞洒发",
"category": 2,
"sup_department_id": "0a5e****-045d-****-aacf-3103776f****",
"ability": "的撒大",
"leader_id": "0a5e****-045d-****-aacf-3103776f****",
"leader_name": "eee",
"branch_leader_id": "500c****-e1a4-****-8cf8-925749f2****",
"branch_leader_name": "陈伟",
"description": "蔡少芬的",
"serial_no": "9",
"manning": "1242",
"open_date": "2025-02-13",
}
参数说明:
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| id | String | 是 | 组织ID |
| name | String | 是 | 组织名称 |
| category | Integer | 否 | 组织类型 |
| short_name | String | 否 | 组织简称 |
| serial_no | String | 否 | 组织代码 |
| sup_department_id | String | 否 | 上级组织ID |
| leader_id | String | 否 | 组织负责人ID |
| leader_name | String | 否 | 组织负责人名称 |
| manning | String | 否 | 组织编制 |
| open_date | String | 是 | 启用日期 |
| branch_leader_id | String | 否 | 组织分管领导ID |
| branch_leader_name | String | 否 | 组织分管领导名称 |
| description | String | 否 | 组织描述 |
| ability | String | 否 | 组织职能 |
说明:
权限说明
返回结果
{
"data": {
"msg": "启用部门成功"
},
"errcode": 0,
"errmsg": ""
}
返回结果
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对异常返回码的文本描述内容 |
| data | 返回数据 |
| msg | 返回码的文本描述内容 |
停用组织¶
使用场景:该接口可用于停用2号的组织。
请求方式:POST(HTTPS)
请求地址:https://openapi.2haohr.com/api/departments/dept_date_close/?access_token=ACCESS_TOKEN
请求示例:
{
"id": "54c0****-f8d9-****-8957-1c8caf06****",
"close_date": "2026-02-21",
"close_reason": "ssss"
}
参数说明:
| 参数 | 类型 | 是否必须 | 说明 |
|---|---|---|---|
| access_token | String | 是 | 调用接口凭证 |
| id | String | 是 | 组织ID |
| close_date | String | 是 | 停用日期 |
| close_reason | String | 否 | 停用原因 |
说明:
权限说明
返回结果
{
"id": "54c0****-f8d9-****-8957-1c8caf06****",
"close_date": "2026-02-21",
"close_reason": "ssss"
}
参数说明:
| 参数 | 说明 |
|---|---|
| errcode | 返回码 |
| errmsg | 对异常返回码的文本描述内容 |
| data | 返回数据 |
| msg | 返回码的文本描述内容 |