多可文档平台API
组织结构接口---获取组织结构的子组列表
根据输入父组ID得到子组, fatherUid如果为空,获取全量组织架构。参数iter=true递归得到子组以及子组的子组等等,iter=false不递归,只返回子组。
请求方式: GET(HTTP/HTTPS)
请求地址: /api/ou/group/list?fuid=ID&iter=ITER&token=ACCESS_TOKEN
参数说明:
参数 | 类型 | 必须 | 说明 |
fatherUid |
string |
否 |
父组id |
token |
string |
是 |
调用接口凭证 |
iter |
bool |
否 |
=true递归,=false 不递归,默认为true |
返回结果示例:
{
"errcode": 0,
"errmsg": "",
"members": [
{
"uid": "G0002",
"name": "演示组",
"outUid": "",
"remark": "",
"from": 4,
"createAt": "2024-06-30 21:30:52",
"orderOfFather": 10000,
"members": []
},
{
"uid": "G0005",
"name": "产品部",
"outUid": "",
"remark": "",
"from": 4,
"createAt": "2025-06-11 20:52:24",
"orderOfFather": 0,
"members": [
{
"uid": "G0006",
"name": "研发1部",
"outUid": "",
"remark": "北方区",
"from": 4,
"createAt": "2025-06-11 20:52:49",
"orderOfFather": 1,
"members": []
}
]
}
]
}
返回参数说明:
参数 | 类型 | 说明 |
errcode |
int32 |
出错返回码,为0表示成功,非0表示调用失败 |
errmsg |
string |
返回码提示语 |
members |
array |
子组 |
---members对象字段 |
uid |
string |
组ID |
name |
string |
组名称 |
outUid |
string |
外部ID(比如钉钉,AD域导入的组ID) |
remark |
string |
组描述 |
from |
byte |
4 系统增加 5 接口导入 6 AD/LDAP导入 7 企业微信导入 8 钉钉导入 10 批量导入 11 其他系统导入 |
createAt |
string |
创建时间 |
orderOfFather |
int32 |
在父组中的排序值 |
权限要求: 需要目标组的【组查看】权限,没有权限返回错误信息。