搜索部门

POST

/open-apis/contact/v3/departments/search

自建应用商店应用

搜索部门，用户通过关键词查询可见的部门数据，部门可见性需要管理员在后台配置。
部门存在，但用户搜索不到并不一定是搜索有问题，可能是管理员在后台配置了权限控制，导致用户无法搜索到该部门

错误码

HTTP状态码	错误码	描述	排查建议
400	48001	invalid param	参数错误，请检查参数
500	48002	Internal Server Error	系统错误

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://open.feishu.cn/open-apis/contact/v3/departments/search?page_size=10' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "query": "DemoName"
}'

响应示例

{
  "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
      }
    ],
    "page_token": "AQD9/Rn9eij9Pm39ED40/RD/cIFmu77WxpxPB/2oHfQLZ%2BG8JG6tK7%2BZnHiT7COhD2hMSICh/eBl7cpzU6JEC3J7COKNe4jrQ8ExwBCR",
    "has_more": true
  }
}

请求参数

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

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

必需

分页大小

示例值： 10

数据校验规则：
最大值：50

示例值:

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

Body 参数application/json

query

string

必需

搜索关键词，匹配字段为部门名称（不支持匹配部门国际化名称）示例值："DemoName"

示例

返回响应

🟢200200 Success

application/json

Body

code

integer

必需

错误码，非 0 表示失败

msg

string

错误描述

必需

data

object

必需

items

array [object {14}]

必需

page_token

string

必需

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

has_more

boolean

是否还有更多项

必需

修改于 2023-01-12 06:29:26

获取父部门信息

资源介绍

搜索部门

错误码#

请求参数

返回响应

错误码