获取知识空间列表
此接口用于获取有权限访问的知识空间列表。
注意事项
- 使用 tenant access token 调用时,请确认应用或机器人拥有部分知识空间的访问权限,否则返回列表为空。参阅如何将应用添加为知识库管理员(成员)。
- 此接口为分页接口。由于权限过滤,可能返回列表为空,但当分页标记(has_more)为 true 时,可以继续分页请求。
- 此接口不会返回我的文档库。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/wiki/v2/spaces |
| HTTP Method | GET |
| 接口频率限制 | 100 次/分钟 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | wiki:space:retrieve 查看知识空间列表 wiki:wiki 查看、编辑和管理知识库 wiki:wiki:readonly 查看知识库 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 或 user_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token |
查询参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
page_size | int | 否 | 分页大小 示例值:10 默认值: 20数据校验规则: - 最大值: 50 |
page_token | string | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果 示例值:1565676577122621 |
响应
响应体
| 名称 | 类型 | 描述 |
|---|---|---|
code | int | 错误码,非 0 表示失败 |
msg | string | 错误描述 |
data | \- | - |
└ items | space\[\] | 数据列表 |
└ name | string | 知识空间名称 |
└ description | string | 知识空间描述 |
└ space_id | string | 知识空间 ID |
└ space_type | string | 表示知识空间类型 可选值有: - team: 团队空间,归团队(多人)管理,可添加多个管理员 - person: 个人空间(旧版,已下线),归个人管理。一人仅可拥有一个,无法添加其他管理员 - my_library: 我的文档库,归个人管理。一人仅可拥有一个,无法添加其他管理员 |
└ visibility | string | 表示知识空间可见性 可选值有: - public: 公开空间,租户内所有用户可见,默认为成员权限。无法额外添加成员,但可以添加管理员 - private: 私有空间,仅对知识空间管理员、成员可见,需要手动添加管理员、成员 |
└ open_sharing | string | 表示知识空间的分享状态 可选值有: - open: 打开,即知识空间发布到互联网 - closed: 关闭,即知识空间未发布到互联网 |
└ page_token | string | 分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token |
└ has_more | boolean | 是否还有更多项 |
响应体示例
json
{
"code": 0,
"msg": "success",
"data": {
"items": [
{
"name": "知识空间",
"description": "知识空间描述",
"space_id": "1565676577122621"
}
],
"page_token": "1565676577122621",
"has_more": true
}
}错误码
| HTTP状态码 | 错误码 | 描述 | 排查建议 |
|---|---|---|---|
| 400 | 131001 | rpc fail | 服务报错(下游 RPC 调用失败),请稍后重试,或者拿响应体的header头里的x-tt-logid咨询oncall定位。 |
| 400 | 131002 | param err | 通常为传参有误,例如数据类型不匹配。请查看响应体 msg 字段中的具体接口报错信息,报错不明确时请咨询oncall。 |
| 400 | 131004 | invalid user | 非法用户(如未登陆或用户 ID 校验失败)。请咨询oncall。 |
| 400 | 131007 | internal err | 服务内部错误,请勿重试,拿返回值的header头里的x-tt-logid咨询oncall定位。 |
