# 批量获取部门信息

调用该接口获取一个或多个部门的信息，包括部门名称、ID、父部门、负责人、状态以及成员个数等。

## 注意事项

使用不同身份调用本接口时，需要注意不同身份所需的不同权限范围。具体说明如下：

- 当你使用应用身份（tenant_access_token）调用本接口时，应用的通讯录权限范围内需要包含当前被查询的部门。如果需要查询根部门信息，则应用的通讯录权限范围需设置为 **全部成员**。了解权限范围参见[权限范围资源介绍](https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM/v3/guides/scope_authority)。
- 当你使用用户身份（user_access_token）调用本接口时，需要确保该用户身份拥有待查询部门的可见性。如果需要查询根部门信息，则用户需要可见所有人。用户的组织架构可见范围需要由企业管理员在[管理后台](https://feishu.cn/admin/index) > **安全** > **成员权限** > **组织架构可见范围** 内调整。

## 请求

基本 | &nbsp;
---|---
HTTP URL | https://open.feishu.cn/open-apis/contact/v3/departments/batch
HTTP Method | GET
接口频率限制 | [1000 次/分钟、50 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 获取通讯录基本信息(contact:contact.base:readonly)
字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请<br>获取通讯录部门组织架构信息(contact:department.organize:readonly)<br>获取部门基础信息(contact:department.base:readonly)<br>获取用户 user ID(contact:user.employee_id:readonly)<br>查询部门 HRBP 信息(contact:department.hrbp:readonly)<br>以应用身份访问通讯录(contact:contact:access_as_app)<br>读取通讯录(contact:contact:readonly)<br>以应用身份读取通讯录(contact:contact:readonly_as_app)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`<br>或<br>`user_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)

### 查询参数

名称 | 类型 | 必填 | 描述
---|---|---|---
department_ids | string\[\] | 是 | 部门 ID，ID 类型需要与查询参数 department_id_type 的取值保持一致。ID 获取方式说明：<br>- 调用[创建部门](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/create)接口后，可从返回结果中获取到部门 ID 信息。<br>- 部门 API 提供了多种获取其他部门 ID 的方式，如[获取子部门列表](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/children)、[获取父部门信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/parent)、[搜索部门](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/search)，你可以选择合适的 API 进行查询。<br>**注意：**<br>- 单次最大请求的 ID 数量为 50。<br>- 如需一次查询多个部门，可将同一参数名多次传递，并且每次传递不同的部门 ID 进行查询。GET 请求示例：<br>`https://{url}?department_ids={department_id1}&department_ids={department_id2}`。其中：<br>- `department_ids` 是参数名，可以多次传递。<br>- `department_id1`和`department_id2`是不同的参数值。<br>**示例值**：D096
department_id_type | string | 否 | 此次调用中的部门 ID 类型。关于部门 ID 的详细介绍，可参见[部门 ID 说明](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/department/field-overview#23857fe0)。<br>**示例值**：open_department_id<br>**可选值有**：<br>- open_department_id：由系统自动生成的部门 ID，ID 前缀固定为 `od-`，在租户内全局唯一。<br>- department_id：支持用户自定义配置的部门 ID。自定义配置时可复用已删除的 department_id，因此在未删除的部门范围内 department_id 具有唯一性。<br>**默认值**：`open_department_id`
user_id_type | string | 否 | 用户 ID 类型<br>**示例值**：open_id<br>**可选值有**：<br>- open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)<br>- union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)<br>- user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id)<br>**默认值**：`open_id`<br>**当值为 `user_id`，字段权限要求**：<br>获取用户 user ID(contact:user.employee_id:readonly)

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
items | department\[\] | 查询到的部门信息。<br>**说明**：多个部门 ID 中的异常部门 ID 不会返回结果。
name | string | 部门名称。<br>**字段权限要求（满足任一）**：<br>获取部门基础信息(contact:department.base:readonly)<br>以应用身份访问通讯录(contact:contact:access_as_app)<br>读取通讯录(contact:contact:readonly)<br>以应用身份读取通讯录(contact:contact:readonly_as_app)
i18n_name | department_i18n_name | 部门名称的国际化配置。<br>**字段权限要求（满足任一）**：<br>获取部门基础信息(contact:department.base:readonly)<br>以应用身份访问通讯录(contact:contact:access_as_app)<br>读取通讯录(contact:contact:readonly)<br>以应用身份读取通讯录(contact:contact:readonly_as_app)
zh_cn | string | 部门的中文名。
ja_jp | string | 部门的日文名。
en_us | string | 部门的英文名。
parent_department_id | string | 父部门的部门 ID。<br>- ID 类型与查询参数的 department_id_type 取值保持一致。<br>-  当父部门为根部门时，该参数值为 `0`。<br>**字段权限要求（满足任一）**：<br>获取通讯录部门组织架构信息(contact:department.organize:readonly)<br>以应用身份访问通讯录(contact:contact:access_as_app)<br>读取通讯录(contact:contact:readonly)<br>以应用身份读取通讯录(contact:contact:readonly_as_app)
department_id | string | 自定义部门 ID。后续可以使用该 ID 删除、修改、查询部门信息。<br>**字段权限要求（满足任一）**：<br>获取部门基础信息(contact:department.base:readonly)<br>以应用身份访问通讯录(contact:contact:access_as_app)<br>读取通讯录(contact:contact:readonly)<br>以应用身份读取通讯录(contact:contact:readonly_as_app)
open_department_id | string | 部门的 open_department_id，由系统自动生成。后续可以使用该 ID 删除、修改、查询部门信息。
leader_user_id | string | 部门主管的用户 ID，ID 类型与查询参数的 user_id_type 取值保持一致。<br>**字段权限要求（满足任一）**：<br>获取通讯录部门组织架构信息(contact:department.organize:readonly)<br>以应用身份访问通讯录(contact:contact:access_as_app)<br>读取通讯录(contact:contact:readonly)<br>以应用身份读取通讯录(contact:contact:readonly_as_app)
chat_id | string | 部门群的群 ID。后续可以使用[获取群信息](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/im-v1/chat/get)，获取群的详细信息。<br>**字段权限要求（满足任一）**：<br>获取部门基础信息(contact:department.base:readonly)<br>以应用身份访问通讯录(contact:contact:access_as_app)<br>读取通讯录(contact:contact:readonly)<br>以应用身份读取通讯录(contact:contact:readonly_as_app)
order | string | 部门的排序，即部门在其同级部门的展示顺序。取值越小排序越靠前。<br>**字段权限要求（满足任一）**：<br>获取通讯录部门组织架构信息(contact:department.organize:readonly)<br>以应用身份访问通讯录(contact:contact:access_as_app)<br>读取通讯录(contact:contact:readonly)<br>以应用身份读取通讯录(contact:contact:readonly_as_app)
unit_ids | string\[\] | 部门绑定的单位自定义 ID 列表，当前只支持一个。<br>**字段权限要求（满足任一）**：<br>获取通讯录部门组织架构信息(contact:department.organize:readonly)<br>以应用身份访问通讯录(contact:contact:access_as_app)<br>读取通讯录(contact:contact:readonly)<br>以应用身份读取通讯录(contact:contact:readonly_as_app)
member_count | int | 当前部门及其下属部门的用户（包含部门负责人）个数。<br>**字段权限要求（满足任一）**：<br>获取通讯录部门组织架构信息(contact:department.organize:readonly)<br>以应用身份访问通讯录(contact:contact:access_as_app)<br>读取通讯录(contact:contact:readonly)<br>以应用身份读取通讯录(contact:contact:readonly_as_app)
status | department_status | 部门状态。<br>**字段权限要求（满足任一）**：<br>获取部门基础信息(contact:department.base:readonly)<br>以应用身份访问通讯录(contact:contact:access_as_app)<br>读取通讯录(contact:contact:readonly)<br>以应用身份读取通讯录(contact:contact:readonly_as_app)
is_deleted | boolean | 是否被删除。<br>**可能值有：**<br>- true：是<br>- false：否
leaders | departmentLeader\[\] | 部门负责人信息。
leaderType | int | 负责人类型。<br>**可选值有**：<br>- 1：主负责人<br>- 2：副负责人
leaderID | string | 负责人的用户 ID，ID 类型与查询参数的 user_id_type 取值保持一致。<br>**字段权限要求（满足任一）**：<br>获取通讯录部门组织架构信息(contact:department.organize:readonly)<br>以应用身份访问通讯录(contact:contact:access_as_app)<br>读取通讯录(contact:contact:readonly)<br>以应用身份读取通讯录(contact:contact:readonly_as_app)
group_chat_employee_types | int\[\] | 部门群的人员类型限制。人员类型的可能值如下：<br>- 1：正式员工<br>- 2：实习生<br>- 3：外包<br>- 4：劳务<br>- 5：顾问<br>如果是自定义人员类型，则会返回对应的编号。你可以调用[查询人员类型](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/list)接口，获取相应编号（enum_value）对应的自定义人员类型信息。
department_hrbps | string\[\] | 部门 HRBP 的用户 ID 列表。 ID 类型与查询参数 user_id_type 的取值保持一致。<br>**字段权限要求**：<br>查询部门 HRBP 信息(contact:department.hrbp:readonly)
primary_member_count | int | 当前部门及其下属部门的主属成员（即成员的主部门为当前部门）的数量。<br>**字段权限要求（满足任一）**：<br>获取通讯录部门组织架构信息(contact:department.organize:readonly)<br>以应用身份访问通讯录(contact:contact:access_as_app)<br>读取通讯录(contact:contact:readonly)<br>以应用身份读取通讯录(contact:contact:readonly_as_app)

### 响应体示例
```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "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
                },
                "leaders": [
                    {
                        "leaderType": 1,
                        "leaderID": "ou_7dab8a3d3cdcc9da365777c7ad535d62"
                    }
                ],
                "group_chat_employee_types": [
                    1
                ],
                "department_hrbps": [
                    "ou_7dab8a3d3cdcc9da365777c7ad535d62"
                ],
                "primary_member_count": 100
            }
        ]
    }
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
400 | 40001 | param is invalid | 参数错误。请检查请求时输出参数是否填写有误。
400 | 43010 | big dept forbid recursion error | 超大部门不允许进行查询。
400 | 40003 | internal error | 内部错误，请获取请求的 X-Request-Id，并向[技术支持](https://applink.feishu.cn/TLJpeNdW)进行反馈。
400 | 40008 | dept Info is null error | 部门的信息不能为空。
403 | 40014 | no parent dept authority error | 操作部门的父部门需在通讯录权限范围中，[了解更多](https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM/v3/guides/scope_authority)。
400 | 40011 | page size is more than 50 error | page_size 参数超过 50，请减少数量后重试。
400 | 40012 | page token is invalid error | 非法的 page_token 参数，请从结果中获取 page_token 后重试。
401 | 42008 | tenant id is invalid error | 租户身份无效。请求时，请求头 Authorization 对应的租户身份，需要是当前操作中的资源的所属租户。
400 | 43007 | duplicated department unit custom id error | 部门 unit 的自定义 ID 重复，请检查数据后重试。
403 | 40004 | no dept authority error | 当前操作涉及的部门，需在应用通讯录权限范围中，了解更多可参见[权限范围资源介绍](https://open.feishu.cn/document/ukTMukTMukTM/uETNz4SM1MjLxUzM/v3/guides/scope_authority)。

更多错误码信息，参见[通用错误码](https://open.feishu.cn/document/ukTMukTMukTM/ugjM14COyUjL4ITN)。

