Skip to content

列出数据表

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

请求

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

请求头

名称类型必填描述
Authorizationstringtenant_access_tokenuser_access_token 值格式:"Bearer access_token" 示例值:"Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多:如何选择与获取 access token

路径参数

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

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述
data\--
  └ has_moreboolean是否还有更多项
  └ page_tokenstring分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
  └ totalint总数
  └ itemsapp.table\[\]数据表信息
    └ table_idstring数据表 ID
    └ revisionint数据表的版本号。对数据表进行修改时更新,如新增、删除记录,修改数据表名称等,初始为 1,每次更新+1
    └ namestring数据表名称

响应体示例

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

错误码

HTTP状态码错误码描述排查建议
2001254000WrongRequestJson请求体错误
2001254001WrongRequestBody请求体错误
2001254002Fail内部错误,有疑问可咨询客服
2001254003WrongBaseTokenapp_token 错误
2001254004WrongTableIdtable_id 错误
2001254005WrongViewIdview_id 错误
2001254006WrongRecordId检查 record_id
2001254007EmptyValue空值
2001254008EmptyView空视图
2001254009WrongFieldId字段 id 错误
2001254010ReqConvError请求错误
4001254011Page size must greater than 0.确认page_size参数的值符合要求。
2001254030TooLargeResponse响应体过大
4001254036Base is copying, please try again later.多维表格副本复制中,稍后重试
2001254040BaseTokenNotFoundapp_token 不存在
2001254041TableIdNotFoundtable_id 不存在
2001254042ViewIdNotFoundview_id 不存在
2001254043RecordIdNotFoundrecord_id 不存在
2001254044FieldIdNotFoundfield_id 不存在
2001254060TextFieldConvFail多行文本字段错误
2001254061NumberFieldConvFail数字字段错误
2001254062SingleSelectFieldConvFail单选字段错误
2001254063MultiSelectFieldConvFail多选字段错误
2001254064DatetimeFieldConvFail日期字段错误
2001254065CheckboxFieldConvFail复选框字段错误
2001254066UserFieldConvFail人员字段有误。原因可能是: - user_id_type 参数指定的 ID 类型与传入的 ID 类型不匹配 - 传入了不识别的类型或结构,目前只支持填写 id 参数,且需要传入数组 - 跨应用传入了 open_id。如果跨应用传入 ID,建议使用 user_id。不同应用获取的 open_id 不能交叉使用
2001254067LinkFieldConvFail关联字段错误
2001254100TableExceedLimit数据表或仪表盘数量超限。每个多维表格中,数据表加仪表盘的数量最多为 100 个
2001254101ViewExceedLimit视图数量超限, 限制200个
2001254102FileExceedLimit超限
2001254103RecordExceedLimit记录数量超限, 限制20,000条
2001254104RecordAddOnceExceedLimit单次添加记录数量超限, 限制500条
2001254130TooLargeCell格子内容过大
2001254290TooManyRequest请求过快,稍后重试
2001254291Write conflict同一个数据表(table) 不支持并发调用写接口,请检查是否存在并发调用写接口。写接口包括:新增、修改、删除记录;新增、修改、删除字段;修改表单;修改视图等。
2001254301OperationTypeError多维表格未开启高级权限或不支持开启高级权限
4031254302The role has no permissions.无访问权限, 常由表格开启了高级权限造成, 如果是用应用请求的话,目前有两种方法对应用赋予高级权限,第一种方法为在表格中添加应用为协作者并将应用设置为管理员,第二种方法为在一个用户群中将应用添加为机器人, 并在高级权限的角色中添加该用户群,从而赋予对应的权限。
2001255001InternalError内部错误,有疑问可咨询客服
2001255002RpcError内部错误,有疑问可咨询客服
2001255003MarshalError序列化错误,有疑问可咨询客服
2001255004UmMarshalError反序列化错误
2001255005ConvError内部错误,有疑问可咨询客服处
5041255040Request timed out, please try again later.请求超时,请进行重试

内容来源:飞书开放平台 · 自动爬取整理