服务端 API/通讯录/部门/搜索部门 # 搜索部门 搜索部门，用户通过关键词查询可见的部门数据，部门可见性需要管理员在后台配置。 **注意事项**：部门存在，但用户搜索不到并不一定是搜索有问题，可能是管理员在后台配置了权限控制，导致用户无法搜索到该部门。 ## 请求 基本 |   ---|--- HTTP URL | https://open.larksuite.com/open-apis/contact/v3/departments/search HTTP Method | POST 支持的应用类型 | Custom App、Store App 权限要求
**调用该 API 所需的权限。开启其中任意一项权限即可调用**
开启任一权限即可 | 以应用身份读取通讯录(contact:contact:readonly_as_app)
以应用身份访问通讯录(contact:contact:access_as_app) 字段权限要求 | **注意事项**：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请
获取部门组织架构信息(contact:department.organize:readonly)
以应用身份读取通讯录(contact:contact:readonly_as_app)
获取部门基础信息(contact:department.base:readonly)
获取用户 user ID(contact:user.employee_id:readonly)
以应用身份访问通讯录(contact:contact:access_as_app)
读取通讯录(contact:contact:readonly) ### 请求头 名称 | 类型 | 必填 | 描述 ---|---|---|--- Authorization | string | 是 | `user_access_token`
**值格式**："Bearer `access_token`"
**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"
[了解更多：如何选择与获取 access token](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use) Content-Type | string | 是 | **固定值**："application/json; charset=utf-8" ### 查询参数 名称 | 类型 | 必填 | 描述 ---|---|---|--- user_id_type | string | 否 | 用户 ID 类型
**示例值**："open_id"
**可选值有**：
- open_id：标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。[了解更多：如何获取 Open ID](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)
- union_id：标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。[了解更多：如何获取 Union ID？](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)
- user_id：标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。[了解更多：如何获取 User ID？](https://open.larksuite.com/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id)
**默认值**：`open_id`
**当值为 `user_id`，字段权限要求**：
获取用户 user ID(contact:user.employee_id:readonly) department_id_type | string | 否 | 此次调用中使用的部门ID的类型
**示例值**："open_department_id"
**可选值有**：
- department_id：用来标识租户内一个唯一的部门
- open_department_id：用来在具体某个应用中标识一个部门，同一个部门 在不同应用中的 open_department_id 不相同。 page_token | string | 否 | 分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果
**示例值**："AQD9/Rn9eij9Pm39ED40/RD/cIFmu77WxpxPB/2oHfQLZ+G8JG6tK7+ZnHiT7COhD2hMSICh/eBl7cpzU6JEC3J7COKNe4jrQ8ExwBCR" page_size | int | 否 | 分页大小
**示例值**：10
**默认值**：`20`
**数据校验规则**：
- 最大值：`50` ### 请求体 名称 | 类型 | 必填 | 描述 ---|---|---|--- query | string | 是 | 搜索关键词，匹配字段为部门名称（不支持匹配部门国际化名称）
**示例值**："DemoName" ### 请求体示例 ```json { "query": "DemoName" } ``` ## 响应 ### 响应体 名称 | 类型 | 描述 ---|---|--- code | int | 错误码，非 0 表示失败 msg | string | 错误描述 data | \- | \- items | department\[\] |   name | string | 部门名称
**字段权限要求（满足任一）**：
以应用身份读取通讯录(contact:contact:readonly_as_app)
获取部门基础信息(contact:department.base:readonly)
以应用身份访问通讯录(contact:contact:access_as_app)
读取通讯录(contact:contact:readonly) i18n_name | department_i18n_name | 国际化的部门名称
**字段权限要求（满足任一）**：
以应用身份读取通讯录(contact:contact:readonly_as_app)
获取部门基础信息(contact:department.base:readonly)
以应用身份访问通讯录(contact:contact:access_as_app)
读取通讯录(contact:contact:readonly) zh_cn | string | 部门的中文名 ja_jp | string | 部门的日文名 en_us | string | 部门的英文名 parent_department_id | string | 父部门的ID
* 在根部门下创建新部门，该参数值为 “0”
**字段权限要求（满足任一）**：
以应用身份读取通讯录(contact:contact:readonly_as_app)
获取部门组织架构信息(contact:department.organize:readonly)
以应用身份访问通讯录(contact:contact:access_as_app)
读取通讯录(contact:contact:readonly) department_id | string | 本部门的自定义部门ID
注意：除需要满足正则规则外，同时不能以`od-`开头
**字段权限要求（满足任一）**：
以应用身份读取通讯录(contact:contact:readonly_as_app)
获取部门基础信息(contact:department.base:readonly)
以应用身份访问通讯录(contact:contact:access_as_app)
读取通讯录(contact:contact:readonly) open_department_id | string | 部门的open_id，类型与通过请求的查询参数传入的department_id_type相同 leader_user_id | string | 部门主管用户ID
**字段权限要求（满足任一）**：
以应用身份读取通讯录(contact:contact:readonly_as_app)
获取部门组织架构信息(contact:department.organize:readonly)
以应用身份访问通讯录(contact:contact:access_as_app)
读取通讯录(contact:contact:readonly) chat_id | string | 部门群ID
**字段权限要求（满足任一）**：
以应用身份读取通讯录(contact:contact:readonly_as_app)
获取部门基础信息(contact:department.base:readonly)
以应用身份访问通讯录(contact:contact:access_as_app)
读取通讯录(contact:contact:readonly) order | string | 部门的排序，即部门在其同级部门的展示顺序
**字段权限要求（满足任一）**：
以应用身份读取通讯录(contact:contact:readonly_as_app)
获取部门组织架构信息(contact:department.organize:readonly)
以应用身份访问通讯录(contact:contact:access_as_app)
读取通讯录(contact:contact:readonly) unit_ids | string\[\] | 部门单位自定义ID列表，当前只支持一个
**字段权限要求（满足任一）**：
以应用身份读取通讯录(contact:contact:readonly_as_app)
获取部门组织架构信息(contact:department.organize:readonly)
以应用身份访问通讯录(contact:contact:access_as_app)
读取通讯录(contact:contact:readonly) member_count | int | 部门下用户的个数
**字段权限要求（满足任一）**：
以应用身份读取通讯录(contact:contact:readonly_as_app)
获取部门组织架构信息(contact:department.organize:readonly)
以应用身份访问通讯录(contact:contact:access_as_app)
读取通讯录(contact:contact:readonly) status | department_status | 部门状态
**字段权限要求（满足任一）**：
以应用身份读取通讯录(contact:contact:readonly_as_app)
获取部门基础信息(contact:department.base:readonly)
以应用身份访问通讯录(contact:contact:access_as_app)
读取通讯录(contact:contact:readonly) is_deleted | boolean | 是否被删除 create_group_chat | boolean | 是否创建部门群，默认不创建。创建部门群时，默认群名为部门名，默认群主为部门主负责人 leaders | departmentLeader\[\] | 部门负责人 leaderType | int | 负责人类型
**可选值有**：
- 1：主负责人
- 2：副负责人 leaderID | string | 负责人ID
**字段权限要求（满足任一）**：
以应用身份读取通讯录(contact:contact:readonly_as_app)
获取部门组织架构信息(contact:department.organize:readonly)
以应用身份访问通讯录(contact:contact:access_as_app)
读取通讯录(contact:contact:readonly) group_chat_employee_types | int\[\] | 部门群雇员类型限制。[]空列表时，表示为无任何雇员类型。类型字段可包含以下值，支持多个类型值；若有多个，用英文','分隔：
1、正式员工
2、实习生
3、外包
4、劳务
5、顾问
6、其他自定义类型字段，可通过下方接口获取到该租户的自定义员工类型的名称，参见[获取人员类型](https://open.larksuite.com/document/uAjLw4CM/ukTMukTMukTM/reference/contact-v3/employee_type_enum/list)。 page_token | string | 分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token has_more | boolean | 是否还有更多项 ### 响应体示例 ```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 }, "create_group_chat": false, "leaders": [ { "leaderType": 1, "leaderID": "ou_7dab8a3d3cdcc9da365777c7ad535d62" } ], "group_chat_employee_types": [ [1,2,3] ] } ], "page_token": "AQD9/Rn9eij9Pm39ED40/RD/cIFmu77WxpxPB/2oHfQLZ%2BG8JG6tK7%2BZnHiT7COhD2hMSICh/eBl7cpzU6JEC3J7COKNe4jrQ8ExwBCR", "has_more": true } } ``` ### 错误码 HTTP状态码 | 错误码 | 描述 | 排查建议 ---|---|---|--- 400 | 48001 | invalid param | 参数错误，请检查参数 500 | 48002 | Internal Server Error | 系统错误