获取单位列表

调用该接口获取当前租户内的单位列表。列表内主要包含各单位的 ID、名字、类型信息。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/contact/v3/unit
HTTP Method	GET
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	contact:unit:readonly 获取单位信息

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token

查询参数

名称	类型	必填	描述
page_size	int	否	分页大小，用于限制一次请求所返回的数据条目数。 示例值：50 默认值：50 数据校验规则： - 最大值：100
page_token	string	否	分页标记，第一次请求不填，表示从头开始遍历；分页查询结果还有更多项时会同时返回新的 page_token，下次遍历可采用该 page_token 获取查询结果 示例值：AQD9/Rn9eij9Pm39ED40/dk53s4Ebp882DYfFaPFbz00L4CMZJrqGdzNyc8BcZtDbwVUvRmQTvyMYicnGWrde9X56TgdBuS+JKiSIkdexPw=

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ unitlist	unit\[\]	单位列表。
└ unit_id	string	单位 ID。
└ name	string	单位名字。
└ unit_type	string	单位类型。
└ has_more	boolean	是否还有更多项
└ page_token	string	分页标记，当 has_more 为 true 时，会同时返回新的 page_token，否则不返回 page_token

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "unitlist": [
            {
                "unit_id": "BU121",
                "name": "消费者事业部",
                "unit_type": "事业部"
            }
        ],
        "has_more": true,
        "page_token": "AQD9/Rn9eij9Pm39ED40/dk53s4Ebp882DYfFaPFbz00L4CMZJrqGdzNyc8BcZtDbwVUvRmQTvyMYicnGWrde9X56TgdBudfdagatagdd="
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
500	40003	internal error	内部错误，请获取请求的 X-Request-Id，并向技术支持进行反馈。
400	40011	page size is invalid	page_size 无效。你需要参考接口文档的 page_size 参数描述，设置正确的值。
400	40012	page token is invalid	page_token 无效。你需要参考接口文档的 page_token 参数描述，设置正确的值。

更多错误码信息，参见通用错误码。