获取单个部门信息

GET

https://open.feishu.cn/open-apis/contact/v3/departments/{department_id}

该接口用于向通讯录获取单个部门信息。

使用tenant_access_token时，应用需要拥有待查询部门的通讯录授权。如果需要获取根部门信息，则需要拥有全员权限。
使用user_access_token时，用户需要有待查询部门的可见性，如果需要获取根部门信息，则要求员工可见所有人。

错误码

HTTP状态码	错误码	描述	排查建议
400	40001	param error	参数错误。
400	43010	big dept forbid recursion error	超大部门不允许进行查询。
400	40003	internal error	内部错误，请提供 X-Request-Id向客服反馈。联系客服。
403	40004	no dept authority error	操作的部门需在通讯录权限范围中，了解更多
400	40008	dept Info is null error	部门的信息不能为空
401	42008	tenant id is invalid error	请检查请求租户是否为合法租户。
400	40015	department not exist	部门不存在，请检查参数是否正确

请求示例

Shell

JavaScript

Java

Swift

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

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "department": {
      "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
      },
      "leaders": [
        {
          "leaderType": 1,
          "leaderID": "ou_7dab8a3d3cdcc9da365777c7ad535d62"
        }
      ],
      "group_chat_employee_types": [
        [
          1,
          2,
          3
        ]
      ]
    }
  }
}

请求参数

Path 参数

department_id

string

必需

Query 参数

department_id

string

可选

需要获取的部门ID 不同 ID 的说明及获取方式参见部门ID说明示例值："D096" 数据校验规则：最大长度：64 字符正则校验：^[a-zA-Z0-9][a-zA-Z0-9_-@.]{0,63}$

user_id_type

string

可选

用户 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

department_id_type

string

可选

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

Header 参数

Authorization

string

必需

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

默认值:

Bearer {{access_token}}

Content-Type

string

必需

固定值："application/json; charset=utf-8"

默认值:

application/json; charset=utf-8

返回响应

🟢200成功

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

department

object

部门信息

必需

修改于 2023-01-12 06:22:48

部门群转为普通群

获取子部门列表

获取单个部门信息

错误码#

请求参数

返回响应

错误码