Files
feishu_bitable/docs/列出数据表.md
2026-03-23 10:50:08 +08:00

7.0 KiB
Raw Blame History

列出数据表

列出多维表格中的所有数据表,包括其 ID、版本号和名称。

请求

基本  
HTTP URL https://open.feishu.cn/open-apis/bitable/v1/apps/:app_token/tables
HTTP Method GET
接口频率限制 20 次/秒
支持的应用类型 Custom App、Store App
权限要求
调用该 API 所需的权限。开启其中任意一项权限即可调用
开启任一权限即可
获取数据表信息(base:table:read)
查看、评论、编辑和管理多维表格(bitable:app)
查看、评论和导出多维表格(bitable:app:readonly)

请求头

名称 类型 必填 描述
Authorization string tenant_access_token

user_access_token
值格式"Bearer access_token"
示例值"Bearer u-7f1bcd13fc57d46bac21793a18e560"
了解更多:如何选择与获取 access token

路径参数

名称 类型 描述
app_token string 多维表格 App 的唯一标识。不同形态的多维表格,其 app_token 的获取方式不同:
- 如果多维表格的 URL 以 ==feishu.cn/base== 开头,该多维表格的 app_token 是下图高亮部分:
app_token.png
- 如果多维表格的 URL 以 ==feishu.cn/wiki== 开头,你需调用知识库相关获取知识空间节点信息接口获取多维表格的 app_token。当 obj_type 的值为 bitable 时,obj_token 字段的值才是多维表格的 app_token
了解更多,参考多维表格 app_token 获取方式
示例值"appbcbWCzen6D8dezhoCH2RpMAh"

查询参数

名称 类型 必填 描述
page_token string 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token下次遍历可采用该 page_token 获取查询结果
示例值tblsRc9GRRXKqhvW
page_size int 分页大小
示例值10
默认值20
数据校验规则
- 最大值:100

响应

响应体

名称 类型 描述
code int 错误码,非 0 表示失败
msg string 错误描述
data - -
has_more boolean 是否还有更多项
page_token string 分页标记,当 has_more 为 true 时,会同时返回新的 page_token否则不返回 page_token
total int 总数
items app.table[] 数据表信息
table_id string 数据表 ID
revision int 数据表的版本号。对数据表进行修改时更新,如新增、删除记录,修改数据表名称等,初始为 1每次更新+1
name string 数据表名称

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "has_more": false,
        "page_token": "tblKz5D60T4JlfcT",
        "total": 1,
        "items": [
            {
                "table_id": "tblKz5D60T4JlfcT",
                "revision": 1,
                "name": "数据表1"
            }
        ]
    }
}

错误码

HTTP状态码 错误码 描述 排查建议
200 1254000 WrongRequestJson 请求体错误
200 1254001 WrongRequestBody 请求体错误
200 1254002 Fail 内部错误,有疑问可咨询客服
200 1254003 WrongBaseToken app_token 错误
200 1254004 WrongTableId table_id 错误
200 1254005 WrongViewId view_id 错误
200 1254006 WrongRecordId 检查 record_id
200 1254007 EmptyValue 空值
200 1254008 EmptyView 空视图
200 1254009 WrongFieldId 字段 id 错误
200 1254010 ReqConvError 请求错误
400 1254011 Page size must greater than 0. 确认page_size参数的值符合要求。
200 1254030 TooLargeResponse 响应体过大
400 1254036 Base is copying, please try again later. 多维表格副本复制中,稍后重试
200 1254040 BaseTokenNotFound app_token 不存在
200 1254041 TableIdNotFound table_id 不存在
200 1254042 ViewIdNotFound view_id 不存在
200 1254043 RecordIdNotFound record_id 不存在
200 1254044 FieldIdNotFound field_id 不存在
200 1254060 TextFieldConvFail 多行文本字段错误
200 1254061 NumberFieldConvFail 数字字段错误
200 1254062 SingleSelectFieldConvFail 单选字段错误
200 1254063 MultiSelectFieldConvFail 多选字段错误
200 1254064 DatetimeFieldConvFail 日期字段错误
200 1254065 CheckboxFieldConvFail 复选框字段错误
200 1254066 UserFieldConvFail 人员字段有误。原因可能是:
- user_id_type 参数指定的 ID 类型与传入的 ID 类型不匹配
- 传入了不识别的类型或结构,目前只支持填写 id 参数,且需要传入数组
- 跨应用传入了 open_id。如果跨应用传入 ID建议使用 user_id。不同应用获取的 open_id 不能交叉使用
200 1254067 LinkFieldConvFail 关联字段错误
200 1254100 TableExceedLimit 数据表或仪表盘数量超限。每个多维表格中,数据表加仪表盘的数量最多为 100 个
200 1254101 ViewExceedLimit 视图数量超限, 限制200个
200 1254102 FileExceedLimit 超限
200 1254103 RecordExceedLimit 记录数量超限, 限制20,000条
200 1254104 RecordAddOnceExceedLimit 单次添加记录数量超限, 限制500条
200 1254130 TooLargeCell 格子内容过大
200 1254290 TooManyRequest 请求过快,稍后重试
200 1254291 Write conflict 同一个数据表(table) 不支持并发调用写接口,请检查是否存在并发调用写接口。写接口包括:新增、修改、删除记录;新增、修改、删除字段;修改表单;修改视图等。
200 1254301 OperationTypeError 多维表格未开启高级权限或不支持开启高级权限
403 1254302 The role has no permissions. 无访问权限, 常由表格开启了高级权限造成, 如果是用应用请求的话,目前有两种方法对应用赋予高级权限,第一种方法为在表格中添加应用为协作者并将应用设置为管理员,第二种方法为在一个用户群中将应用添加为机器人, 并在高级权限的角色中添加该用户群,从而赋予对应的权限。
200 1255001 InternalError 内部错误,有疑问可咨询客服
200 1255002 RpcError 内部错误,有疑问可咨询客服
200 1255003 MarshalError 序列化错误,有疑问可咨询客服
200 1255004 UmMarshalError 反序列化错误
200 1255005 ConvError 内部错误,有疑问可咨询客服处
504 1255040 Request timed out, please try again later. 请求超时,请进行重试