获取子部门列表

GET

/open-apis/contact/v3/departments/{department_id}/children

自建应用商店应用

通过部门ID获取部门的子部门列表。
部门ID 必填，根部门的部门ID 为0
使用 user_access_token 时，返回该用户组织架构可见性范围（登陆企业管理后台进行权限配置）内的所有可见部门。当进行递归查询时，只筛查最多1000个部门的可见性。
使用tenant_access_token 则基于应用的通讯录权限范围进行权限校验与过滤。如果部门ID为0，会检验应用是否有全员通讯录权限，如果是非0 部门ID，则会校验应用是否有该部门的通讯录权限。无部门权限返回无部门通讯录权限错误码，有权限则返回部门下子部门列表（根据fetch_child决定是否递归）。

错误码

HTTP状态码	错误码	描述	排查建议
400	43010	big dept forbid recursion error	超大部门不允许进行查询。
400	40003	internal error	内部错误，请提供 X-Request-Id向客服反馈。联系客服。
400	40008	dept Info is null error	部门的信息不能为空
403	40014	no parent dept authority error	没有父部门权限（组织架构可见范围权限）。
400	40011	page size is invalid	无效的分页参数
400	40012	page token is invalid error	page token无效。
401	42008	tenant id is invalid error	请检查请求租户是否为合法租户。
400	43007	duplicated department custom id error	部门自定义ID 企业内重复
403	40004	no dept authority error	操作的部门需在通讯录权限范围中，了解更多

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://open.feishu.cn/open-apis/contact/v3/departments/od-4e6ac4d14bcd5071a37a39de902c7141/children' \
--header 'Authorization;'

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "has_more": true,
    "page_token": "AQD9/Rn9eij9Pm39ED40/RD/cIFmu77WxpxPB/2oHfQLZ%2BG8JG6tK7%2BZnHiT7COhD2hMSICh/eBl7cpzU6JEC3J7COKNe4jrQ8ExwBCR",
    "items": [
      {
        "name": "DemoName",
        "i18n_name": {
          "zh_cn": "Demo名称",
          "ja_jp": "デモ名",
          "en_us": "Demo Name"
        },
        "parent_department_id": "D067",
        "department_id": "D096",
        "open_department_id": "od-4e6ac4d14bcd5071a37a39de902c7141",
        "leader_user_id": "ou_7dab8a3d3cdcc9da365777c7ad535d62",
        "chat_id": "oc_5ad11d72b830411d72b836c20",
        "order": "100",
        "unit_ids": [
          "custom_unit_id"
        ],
        "member_count": 100,
        "status": {
          "is_deleted": false
        },
        "create_group_chat": false
      }
    ]
  }
}

请求参数

Path 参数

department_id

string

必需

部门ID，根部门的部门ID 为0 示例值："od-4e6ac4d14bcd5071a37a39de902c7141" 数据校验规则：最大长度：64 字符正则校验：^0|[^od][A-Za-z0-9]*

示例值:

od-4e6ac4d14bcd5071a37a39de902c7141

Query 参数

user_id_type

可选

用户 ID 类型示例值："open_id" 可选值有： open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？默认值：open_id 当值为 user_id，字段权限要求：获取用户 user ID

示例值:

open_id

department_id_type

可选

此次调用中使用的部门ID的类型不同 ID 的说明与department_id的获取方式参见部门ID说明示例值："open_department_id" 可选值有： department_id：用来标识租户内一个唯一的部门 open_department_id：用来在具体某个应用中标识一个部门，同一个部门在不同应用中的 open_department_id 不相同。默认值：open_department_id

示例值:

open_department_id

fetch_child

可选

是否递归获取子部门示例值： false

示例值:

false

page_token

可选

分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果

示例值:

AQD9/Rn9eij9Pm39ED40/RD/cIFmu77WxpxPB/2oHfQLZ+G8JG6tK7+ZnHiT7COhD2hMSICh/eBl7cpzU6JEC3J7COKNe4jrQ8ExwBCR

page_size

分页大小，最大50

可选

示例值:

Header 参数

Authorization

string

必需

tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560"

默认值:

Bearer {{access_token}}

返回响应

🟢200200 Success

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

has_more

boolean

是否还有更多项

必需

page_token

string

必需

分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token

items

array [object {14}]

部门列表

必需

修改于 2023-01-12 06:25:27

获取单个部门信息

获取父部门信息

获取子部门列表

错误码#

请求参数

返回响应

错误码