查询企业部门列表_通义灵码_智能编码助手_智能编码助手通义灵码(Lingma)-阿里云帮助中心

通过 OpenAPI 查询企业部门列表。

适用版本

企业专属版

服务接入点

获取服务接入点，替换 API 请求语法中的 {domain} 。

产品	资源	所需权限
组织管理	企业部门	只读

GET https://{domain}/oapi/v1/platform/departments?parentId={parentId}&page={page}&perPage={perPage}

请求说明	查询企业一级部门 `curl -X 'GET' \ 'https://test-domain-*.rdc.aliyuncs.com/oapi/v1/platform/departments' \ -H 'Content-Type: application/json' \ -H 'x-yunxiao-token: pt-0fh30fbG_35af0484'` 查询父部门的所有子部门 `curl -X 'GET' \ 'https://test-domain-.rdc.aliyuncs.com/oapi/v1/platform/departments?parentId=ebeb5a64-c98c-478a-9d9d-513841da*&page=1&perPage=100' \ -H 'Content-Type: application/json' \ -H 'x-yunxiao-token: pt-0fh30fbG_35af**0484'`
请求头（Headers）
x-yunxiao-token `string` （必选）个人访问令牌。您可参考个人访问令牌获取。示例：pt-0fh3**0fbG_35af**0484。
请求参数
parentId `string` （可选）父部门 ID。如果不传值，会返回企业一级部门列表。如果传值，且该部门下有子部门时，会返回父部门下子部门列表，但不包括孙部门；如果无子部门时，会返回空列表。
page `integer` （可选）默认值为`1` 当前页。
perPage `integer` （可选）默认值为`100` 每页数据条数，取值范围：`[1, 100]` 。

返回参数	返回示例 `[ { "id": "204769ba-7f70-478b-a7af-4513281c**", "name": "文档开发部1", "creatorId": "bf2fce4f-7048-4017-a734-1c346e68", "parentId": "ebeb5a64-c98c-478a-9d9d-513841da" }, { "id": "f2f160ea-2d00-4b00-addd-1d89a760", "name": "文档开发部2", "creatorId": "2e625bbd-c1a8-41de-b734-2558e72f", "parentId": "ebeb5a64-c98c-478a-9d9d-513841da**", "hasSub": true }, ]`
id `string` 部门 ID。
name `string` 部门名称。
creatorId `string` 创建人 ID。
parentId `string` 父部门 ID。
hasSub `boolean` 是否有子部门。 true：表示有子部门。 false：当不存在子部门时，该参数不返回。

访问错误码中心查看 API 相关错误码。