获取父部门信息

GET

/open-apis/contact/v3/departments/parent

自建应用商店应用

该接口用来递归获取部门父部门的信息，并按照由子到父的顺序返回有权限的父部门信息列表。
使用tenant_access_token时,该接口只返回可见性范围内的父部门信息
例如：A >>B>>C>>D四级部门，通讯录权限只到B，那么查询D部门的parent，会返回B和C两级部门。使用user_access_token时,该接口只返回对于用户可见的父部门信息

错误码

HTTP状态码	错误码	描述	排查建议
409	43001	dept unit repeat error	部门unit id冲突。
409	43002	dept unit is still using error	部门unit id已存在。
409	43003	multi dept unit error	存在多个部门unit id。
400	43004	illegal unit error	部门unit id无效。
400	43005	duplicate order error	部门的order必须唯一，请检查后重试。
400	40001	param error	参数错误。
400	43007	duplicated department custom id error	部门自定义ID 企业内重复
400	43008	custom dept id invalid error	部门自定义ID不合法，不得以od-开头，不能为“0”，长度不可超过64。
400	43009	exceed update custom dept limit error	超过部门自定义id次数限制。
400	43010	big dept forbid recursion error	超大部门不允许进行查询。
400	43013	dept too many children error	子部门数量过多。
400	43011	delete has member dept error	待删除的部门下不能包含用户，请检查部门中是否还有未删除的用户。
400	43012	delete has sub dept department error	待删除的部门下不能包含部门，请检查部门中是否还有未删除的子部门。
400	40002	process root dept error	不能对根部门进行移除部门群处理
400	40003	internal error	内部错误，请提供 X-Request-Id向客服反馈。联系客服。
403	40004	no dept authority error	操作的部门需在通讯录权限范围中，了解更多
400	40008	dept Info is null error	部门的信息不能为空
400	40010	chat id is invalid error	部门群ID格式错误。
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	44102	miss department_id error	请求缺少department_id

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://open.feishu.cn/open-apis/contact/v3/departments/parent?department_id=od-64242a18099d3a31acd24d8fce8d9f9c' \
--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
        }
      }
    ]
  }
}

请求参数

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的类型示例值："open_department_id" 可选值有： department_id：用来标识租户内一个唯一的部门 open_department_id：用来在具体某个应用中标识一个部门，同一个部门在不同应用中的 open_department_id 不相同。

示例值:

open_department_id

department_id

必需

部门ID

示例值： "od-4e6ac4d14bcd5071a37a39de902c7141"

示例值:

od-64242a18099d3a31acd24d8fce8d9f9c

page_token

string

可选

分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果示例值："AQD9/Rn9eij9Pm39ED40/RD/cIFmu77WxpxPB/2oHfQLZ+G8JG6tK7+ZnHiT7COhD2hMSICh/eBl7cpzU6JEC3J7COKNe4jrQ8ExwBCR"

示例值:

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

必需

错误码，非 0 表示失败

data

object

必需

has_more

boolean

是否还有更多项

必需

page_token

string

必需

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

items

array [object {13}]

必需

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

获取子部门列表

搜索部门

获取父部门信息

错误码#

请求参数

返回响应

错误码