接口文档：查询下级组织的组织数据

scope: org:child:list

body参数

名称	类型	是否必填	描述
corpId	String	是	企业ID
parentOrgIdList	Array of String	否	上级组织ID列表（1-20个，不传则查询根组织下的子组织）
effectDate	String	否	生效日期（格式：yyyy-MM-dd，未传则使用当前日期）
page	Integer	否	当前页数（默认1，最小值1）
pageSize	Integer	否	每页大小（默认30，最大100）

返回参数

名称	类型	描述
success	Boolean	接口是否响应成功
errorCode	String	错误码（成功时为null）
errorMsg	String	错误提示原因（成功时为null）
data	Object	返回结果（分页数据）

data 数据结构

名称	类型	描述
list	Array of Object	组织列表
total	Integer	总记录数
page	Integer	当前页码
pageSize	Integer	每页大小

list 数组元素结构

名称	类型	描述
corpId	String	企业ID
orgId	String	组织ID
dataMap	Object	组织详细属性数据

dataMap 组织属性字段说明

一、基础信息字段

字段名	类型	描述
id	String	记录唯一标识（ObjectId）
orgId	String	组织ID
corpId	String	企业ID
name	String	组织名称
code	String	组织编码
type	String	组织类型
order	Integer	组织序号（用于排序）
status	String	组织状态（enable-启用，disable-停用）
disable	Boolean	是否停用
delete	String	删除状态（"0"-正常，其他值表示已删除）
syncStatus	String	同步状态（"true"-已同步）

二、组织关系字段

字段名	类型	描述
parentOrgId	String	上级组织ID
managerEmpId	Array of String	组织负责人员工ID列表
children	Array	子组织列表（列表查询时为空数组）

三、关联信息字段

字段名	类型	描述
costCenterId	String	成本中心ID
costCenterCode	String	成本中心编码
contractCompany	String	合同公司(Id值)

四、日期字段

字段名	类型	描述
effectDate	String	生效日期（格式：yyyy-MM-dd HH:mm:ss）
invalidDate	String	失效日期（格式：yyyy-MM-dd HH:mm:ss）
gmtCreate	String	创建时间（格式：yyyy-MM-dd HH:mm:ss）
gmtModified	String	修改时间（格式：yyyy-MM-dd HH:mm:ss）

五、自定义字段

字段名模式	类型	描述
field_org_stri_xxx	String	自定义字符串字段
field_org_date_xxx	String	自定义日期字段（格式：yyyy-MM-dd HH:mm:ss）
field_org_numb_xxx	Number	自定义数字字段
field_org_sele_xxx	Array of String	自定义下拉字段（选项value数组）

枚举值说明

type 组织类型（需要根据字段配置）

value	label
department	部门
company	公司
group	集团

status 组织状态

value	label
enable	启用
disable	停用

delete 删除状态

value	label
0	正常
(UUID)	已删除

返回示例

{
    "data": {
        "list": [
            {
                "corpId": "ding52e9b5335305552324f2f5cc6abecb85",
                "orgId": "org_29352eaf6d8d4f9d8934895e9e0a3ef3",
                "dataMap": {
                    "effectDate": "1900-01-01 00:00:00",
                    "gmtModified": "2024-04-22 18:08:30",
                    "code": "9764477",
                    "corpId": "ding52e9b5335305552324f2f5cc6abecb85",
                    "type": "department",
                    "gmtCreate": "2024-04-01 19:47:28",
                    "invalidDate": "2099-12-31 00:00:00",
                    "delete": "0",
                    "orgId": "org_29352eaf6d8d4f9d8934895e9e0a3ef3",
                    "parentOrgId": "1",
                    "children": [],
                    "disable": false,
                    "name": "法务审计部",
                    "id": "660a9ed09f289e1be6f64e98",
                    "syncStatus": "true",
                    "status": "enable",
                    "order": 3
                }
            },
            {
                "corpId": "ding52e9b5335305552324f2f5cc6abecb85",
                "orgId": "org_6e2f55649d054905b0c03d3cad7afb9c",
                "dataMap": {
                    "effectDate": "1900-01-01 00:00:00",
                    "gmtModified": "2024-04-22 18:08:08",
                    "code": "961001157",
                    "corpId": "ding52e9b5335305552324f2f5cc6abecb85",
                    "type": "department",
                    "gmtCreate": "2024-04-01 19:47:30",
                    "invalidDate": "2099-12-31 00:00:00",
                    "delete": "0",
                    "orgId": "org_6e2f55649d054905b0c03d3cad7afb9c",
                    "parentOrgId": "1",
                    "children": [],
                    "disable": false,
                    "name": "技术应用研究院",
                    "id": "660a9ed29f289e1be6f64ebc",
                    "syncStatus": "true",
                    "status": "enable",
                    "order": 3
                }
            },
            {
                "corpId": "ding52e9b5335305552324f2f5cc6abecb85",
                "orgId": "org_28f737b1fd8c4595977be325bb917383",
                "dataMap": {
                    "effectDate": "2024-04-23 00:00:00",
                    "gmtModified": "2024-04-23 14:43:07",
                    "code": "9764350",
                    "corpId": "ding52e9b5335305552324f2f5cc6abecb85",
                    "managerEmpId": [
                        "emp_24d0aaff064b419f9f004405ebc23b06"
                    ],
                    "type": "department",
                    "gmtCreate": "2024-04-23 14:43:07",
                    "invalidDate": "2099-12-31 00:00:00",
                    "delete": "0",
                    "orgId": "org_28f737b1fd8c4595977be325bb917383",
                    "parentOrgId": "1",
                    "children": [],
                    "disable": false,
                    "name": "战略客户开发部",
                    "id": "6627587b95f9b25aea683c01",
                    "syncStatus": "true",
                    "status": "enable",
                    "order": 3
                }
            }
        ],
        "total": 26,
        "page": 1,
        "pageSize": 10
    },
    "success": true,
    "errorCode": null,
    "errorMsg": null
}

注意事项

生效日期查询：接口根据 effectDate 参数查询在该时间点生效的组织数据，支持查询组织的历史版本

父组织过滤：parentOrgIdList 用于指定查询哪些组织的下级，不传时默认查询根组织下的子组织

分页限制：单次查询最多返回100条记录，如需查询更多请使用分页

自定义字段：dataMap 中以 field_org_ 开头的字段为企业自定义字段，字段名格式为 field_org_{type}_{fieldId}

下拉字段值：自定义下拉字段返回的是选项 value 数组，如需获取 label 需调用字段定义接口

children 字段：在列表查询中 children 字段返回空数组，如需获取更深层级的子组织需递归调用本接口

负责人字段：managerEmpId 可能不存在或为空数组，表示该组织未设置负责人

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数application/json

示例

{
    "corpId": "ding922b98aebd06ae75a1320dcb25e91351",
    "page": 1,
    "parentOrgIdList": [
        "1"
    ],
    "effectDate": "1974-10-22"
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Bodyapplication/json

示例

{
    "data": {
        "list": [
            {
                "corpId": "string",
                "orgId": "string",
                "dataMap": {
                    "key": {}
                }
            }
        ],
        "total": 0,
        "totalSizeForSelect": 0,
        "page": 0,
        "pageSize": 0,
        "notDataPermission": true
    },
    "success": true,
    "errorCode": "string",
    "errorMsg": "string"
}

查询下级组织的组织数据

接口文档：查询下级组织的组织数据#

body参数#

返回参数#

data 数据结构#

list 数组元素结构#

dataMap 组织属性字段说明#

一、基础信息字段#

二、组织关系字段#

三、关联信息字段#

四、日期字段#

五、自定义字段#

枚举值说明#

type 组织类型（需要根据字段配置）#

status 组织状态#

delete 删除状态#

返回示例#

注意事项#