ListSysDepts - 查询企业部门列表

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

适用版本

企业专属版

前提条件

产品

资源

所需权限

基础服务

企业部门

只读

请求语法

GET https://{domain}/oapi/v1/platform/departments

请求头

参数

类型

是否必填

描述

示例值

x-yunxiao-token

string

个人访问令牌。

pt-0fh3****0fbG_35af****0484

请求参数

参数

类型

位置

是否必填

描述

示例值

parentId

string

query

父部门 ID。

99d1****6124

page

integer

query

当前页,默认1。

1

perPage

integer

query

每页数据条数,1<=perPage<=100,默认100。

10

请求示例

curl -X 'GET' \
  'https://test.rdc.aliyuncs.com/oapi/v1/platform/departments?parentId={parentId}&page={page}&perPage={perPage}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数

类型

描述

示例值

-

array

-

object

creatorId

string

创建人 ID。

99d1****6124

hasSub

boolean

是否有子部门。

true

id

string

部门 ID。

99d1****6124

name

string

部门名称。

示例名

parentId

string

父部门 ID。

99d1****6124

type

string

部门类型。

ROOT

返回示例

[
    {
        "creatorId": "99d1****6124",
        "hasSub": true,
        "id": "99d1****6124",
        "name": "示例名",
        "parentId": "99d1****6124",
        "type": "ROOT"
    }
]

响应头

参数

描述

示例值

x-next-page

下一页。

2

x-page

当前页。

1

x-per-page

每页大小。

20

x-prev-page

前一页。

0

x-request-id

请求 ID。

37294673-00CA-5B8B-914F-A8B35511E90A

x-total

总数。

10

x-total-pages

总分页数。

1

错误码

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