批量获取记录

通过多个记录 ID 查询记录信息。该接口最多支持查询 100 条记录。

注意事项

若多维表格开启了高级权限，你需确保调用身份拥有多维表格的可管理权限，否则可能出现调用成功但返回数据为空的情况。了解具体步骤，参考如何为应用或用户开通文档权限。

请求

基本
HTTP URL	https://open.feishu.cn/open-apis/bitable/v1/apps/:app_token/tables/:table_id/records/batch_get
HTTP Method	POST
接口频率限制	20 次/秒
支持的应用类型	Custom App、Store App
权限要求调用该 API 所需的权限。开启其中任意一项权限即可调用开启任一权限即可	检索特定记录(base:record:read) 查看、评论、编辑和管理多维表格(bitable:app) 查看、评论和导出多维表格(bitable:app:readonly)
字段权限要求	注意事项：该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请获取用户基本信息(contact:user.base:readonly) 以应用身份访问通讯录(contact:contact:access_as_app) 读取通讯录(contact:contact:readonly) 以应用身份读取通讯录(contact:contact:readonly_as_app)

请求头

名称	类型	必填	描述
Authorization	string	是	`tenant_access_token` 或 `user_access_token` 值格式："Bearer `access_token`" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

路径参数

名称	类型	描述
app_token	string	多维表格 App 的唯一标识。不同形态的多维表格，其 `app_token` 的获取方式不同： - 如果多维表格的 URL 以 ==feishu.cn/base== 开头，该多维表格的 `app_token` 是下图高亮部分： - 如果多维表格的 URL 以 ==feishu.cn/wiki== 开头，你需调用知识库相关获取知识空间节点信息接口获取多维表格的 app_token。当 `obj_type` 的值为 `bitable` 时，`obj_token` 字段的值才是多维表格的 `app_token`。了解更多，参考多维表格 app_token 获取方式。示例值："NQRxbRkBMa6OnZsjtERcxhabcef" 数据校验规则： - 长度范围：`0` ～ `100` 字符
table_id	string	多维表格数据表的唯一标识。获取方式： - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id` - 也可通过列出数据表接口获取 `table_id` 示例值："tbl0xe5g8PPabcef" 数据校验规则： - 长度范围：`0` ～ `50` 字符

请求体

名称	类型	必填	描述
record_ids	string[]	是	记录 ID 列表。调用查询记录获取。示例值：["recyO3299N"] 数据校验规则： - 长度范围：`1` ～ `100`
user_id_type	string	否	此次调用中使用的用户 id 的类型示例值："open_id" 可选值有： - user_id：以user_id来识别用户 - union_id：以union_id来识别用户 - open_id：以open_id来识别用户
with_shared_url	boolean	否	是否返回记录的分享链接。可选值： - true：返回分享链接 - false：不返回分享链接默认值：false 示例值：true
automatic_fields	boolean	否	是否返回自动计算的字段。可选值： - true：返回自动计算的字段 - false：不返回自动计算的字段默认值：false 示例值：true

请求体示例

{
  "record_ids": [
    "recyOaMB2F",
    "rec111111",
    "recyOaMB2F"
  ],
  "user_id_type": "open_id",
  "with_shared_url": true,
  "automatic_fields": true
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	-	-
records	app.table.record[]	记录列表
fields	map<string, union>	记录字段
record_id	string	记录 ID
created_by	person	创建人信息
id	string	创建人 ID。ID 类型与请求体中的 `user_id_type` 指定的类型一致。
name	string	创建人中文姓名
en_name	string	创建人英文姓名
email	string	创建人邮箱
avatar_url	string	创建人头像链接字段权限要求（满足任一）：获取用户基本信息(contact:user.base:readonly) 以应用身份访问通讯录(contact:contact:access_as_app) 读取通讯录(contact:contact:readonly) 以应用身份读取通讯录(contact:contact:readonly_as_app)
created_time	int	创建时间。毫秒级时间戳。
last_modified_by	person	修改人信息
id	string	修改人 ID。ID 类型与请求体中的 `user_id_type` 指定的类型一致。
name	string	修改人中文姓名
en_name	string	修改人英文姓名
email	string	修改人邮箱
avatar_url	string	修改人头像链接字段权限要求（满足任一）：获取用户基本信息(contact:user.base:readonly) 以应用身份访问通讯录(contact:contact:access_as_app) 读取通讯录(contact:contact:readonly) 以应用身份读取通讯录(contact:contact:readonly_as_app)
last_modified_time	int	最近更新时间。毫秒级时间戳。
shared_url	string	记录分享链接
record_url	string	记录链接（检索记录接口将返回该字段，本接口不返回）
forbidden_record_ids	string[]	禁止访问的记录列表（针对开启了高级权限的多维表格）
absent_record_ids	string[]	不存在的记录列表

响应体示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "forbidden_record_ids": [
      "recyOaMB2F"
    ],
    "absent_record_ids": [
      "rec111111"
    ],
    "records": [
      {
        "created_by": {
          "avatar_url": "https://internal-api-lark-file.feishu.cn/static-resource/v1/06d568cb-f464-4c2e-bd03-76512c545c5j~?image_size=72x72&amp;cut_type=default-face&amp;quality=&amp;format=jpeg&amp;sticker_format=.webp",
          "email": "",
          "en_name": "Min Zhang",
          "id": "ou_92945f86a98bba075174776959c90eda",
          "name": "张敏"
        },
        "created_time": 1691049973000,
        "fields": {
          "人员": [
            {
              "avatar_url": "https://internal-api-lark-file.feishu.cn/static-resource/v1/b2-7619-4b8a-b27b-c72d90b06a2j~?image_size=72x72&amp;cut_type=default-face&amp;quality=&amp;format=jpeg&amp;sticker_format=.webp",
              "email": "minzhang.leben@bytedance.com",
              "en_name": "Min Zhang",
              "id": "ou_2910013f1e6456f16a0ce75ede950a0a",
              "name": "张敏"
            },
            {
              "avatar_url": "https://internal-api-lark-file.feishu.cn/static-resource/v1/v2_q86-fcb6-4f18-85c7-87ca8881e50j~?image_size=72x72&amp;cut_type=default-face&amp;quality=&amp;format=jpeg&amp;sticker_format=.webp",
              "email": "minzhang.00@bytedance.com",
              "en_name": "Min Zhang",
              "id": "ou_e04138c9633dd0d2ea166d79f548ab5d",
              "name": "张敏"
            }
          ],
          "修改人": [
            {
              "avatar_url": "https://internal-api-lark-file.feishu.cn/static-resource/v1/06d568cb-f464-4c2e-bd03-76512c545c5j~?image_size=72x72&amp;cut_type=default-face&amp;quality=&amp;format=jpeg&amp;sticker_format=.webp",
              "email": "",
              "en_name": "Min Zhang",
              "id": "ou_92945f86a98bba075174776959c90eda",
              "name": "张敏"
            }
          ],
          "创建人": [
            {
              "avatar_url": "https://internal-api-lark-file.feishu.cn/static-resource/v1/06d568cb-f464-4c2e-bd03-76512c545c5j~?image_size=72x72&amp;cut_type=default-face&amp;quality=&amp;format=jpeg&amp;sticker_format=.webp",
              "email": "",
              "en_name": "Min Zhang",
              "id": "ou_92945f86a98bba075174776959c90eda",
              "name": "张敏"
            }
          ],
          "创建时间": 1691049973000,
          "单向关联": {
            "link_record_ids": [
              "recnVYsuqV"
            ]
          },
          "单选": "选项1",
          "双向关联": {
            "link_record_ids": [
              "recqLvMaXT",
              "recrdld32q"
            ]
          },
          "地理位置": {
            "address": "东长安街",
            "adname": "东城区",
            "cityname": "北京市",
            "full_address": "天安门广场，北京市东城区东长安街",
            "location": "116.397755,39.903179",
            "name": "天安门广场",
            "pname": "北京市"
          },
          "复选框": true,
          "多行文本": [
            {
              "text": "多行文本内容1",
              "type": "text"
            },
            {
              "mentionNotify": false,
              "mentionType": "User",
              "name": "张敏",
              "text": "@张敏",
              "token": "ou_2910013f1e6456f16a0ce75ede950a0a",
              "type": "mention"
            }
          ],
          "多选": [
            "选项1",
            "选项2"
          ],
          "数字": 2323.2323,
          "日期": 1690992000000,
          "最后更新时间": 1702455191000,
          "条码": [
            {
              "text": "123",
              "type": "text"
            }
          ],
          "电话号码": "131xxxx6666",
          "自动编号": "17",
          "群组": [
            {
              "avatar_url": "https://internal-api-lark-file.feishu-boe.cn/static-resource/v1/v2_c8d2cd50-ba29-476f-b7f1-5b5917cb18ej~?image_size=72x72&amp;cut_type=&amp;quality=&amp;format=jpeg&amp;sticker_format=.webp",
              "id": "oc_cd07f55f14d6f4a4f1b51504e7e97f48",
              "name": "武侠聊天组"
            }
          ],
          "评分": 3,
          "货币": 1,
          "超链接": {
            "link": "https://bitable.feishu.cn",
            "text": "飞书多维表格官网"
          },
          "进度": 0.66,
          "附件": [
            {
              "file_token": "Vl3FbVkvnowlgpxpqsAbBrtFcrd",
              "name": "飞书.jpeg",
              "size": 32975,
              "tmp_url": "https://open.feishu.cn/open-apis/drive/v1/medias/batch_get_tmp_download_url?file_tokens=Vl3FbVk11owlgpxpqsAbBrtFcrd&amp;extra=%7B%22bitablePerm%22%3A%7B%22tableId%22%3A%22tblBJyX6jZteblYv%22%2C%22rev%22%3A90%7D%7D",
              "type": "image/jpeg",
              "url": "https://open.feishu.cn/open-apis/drive/v1/medias/Vl3FbVk11owlgpxpqsAbBrtFcrd/download?extra=%7B%22bitablePerm%22%3A%7B%22tableId%22%3A%22tblBJyX6jZteblYv%22%2C%22rev%22%3A90%7D%7D"
            }
          ]
        },
        "last_modified_by": {
          "avatar_url": "https://internal-api-lark-file.feishu.cn/static-resource/v1/06d568cb-f464-4c2e-bd03-76512c545c5j~?image_size=72x72&amp;cut_type=default-face&amp;quality=&amp;format=jpeg&amp;sticker_format=.webp",
          "email": "",
          "en_name": "Min Zhang",
          "id": "ou_92945f86a98bba075174776959c90eda",
          "name": "张敏"
        },
        "last_modified_time": 1702455191000,
        "record_id": "recyOaMB2F",
        "shared_url": "https://example.feishu.cn/record/KBcNrNtpWePAlscCvdmb6ZcSc5b"
      }
    ]
  }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	1254000	WrongRequestJson	请求体错误。请检查请求参数
400	1254001	WrongRequestBody	请求体错误。请检查请求参数
500	1254002	Fail	导致报 1254002 错误码的场景较多，请参考以下建议排查： - 如果单次操作的内容变更较大，请尝试在单次操作中减少数据量 - 如果你并发调用了接口，请尝试控制请求间隔，稍后重试 - 如果在知识库（wiki）中创建多维表格，请检查你是否使用了知识库创建知识空间节点接口创建多维表格。在此场景下不能使用创建多维表格接口 - 请检查接口参数是否有误。例如，在分页查询多维表格时，传递了无效的 page_token，或传递了错误的数据表的 table_id - 如果该报错偶尔发生，可能是服务器超时或不稳定，请重试解决
400	1254003	WrongBaseToken	app_token 错误。app_token 是多维表格 App 的唯一标识。不同形态的多维表格，其 `app_token` 的获取方式不同： - 如果多维表格的 URL 以 ==feishu.cn/base== 开头，该多维表格的 `app_token` 是下图高亮部分： - 如果多维表格的 URL 以 ==feishu.cn/wiki== 开头，你需调用知识库相关获取知识空间节点信息接口获取多维表格的 app_token。当 `obj_type` 的值为 `bitable` 时，`obj_token` 字段的值才是多维表格的 `app_token`。了解更多，参考多维表格 app_token 获取方式。
400	1254004	WrongTableId	table_id 错误。table_id 是多维表格数据表的唯一标识。获取方式： - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id` - 也可通过列出数据表接口获取 `table_id`
400	1254005	WrongViewId	view_id 错误。view_id 是多维表格中视图的唯一标识。获取方式： - 在多维表格的 URL 地址栏中，`view_id` 是下图中高亮部分： - 通过列出视图接口获取。暂时无法获取到嵌入到云文档中的多维表格的 `view_id`。注意：当 `filter` 参数或 `sort` 参数不为空时，请求视为对数据表中的全部数据做条件过滤，指定的 `view_id` 会被忽略。
400	1254006	WrongRecordId	record_id 错误。record_id 是数据表中一条记录的唯一标识。通过查询记录接口获取
400	1254007	EmptyValue	空值
400	1254008	EmptyView	空视图
400	1254009	WrongFieldId	field_id 错误。field_id 是数据表中一个字段的唯一标识。通过列出字段接口获取
400	1254010	ReqConvError	请求错误
400	1254011	Page size must greater than 0.	page_size参数非法
400	1254016	InvalidSort	Sort参数错误
400	1254018	InvalidFilter	filter 参数错误。请参考记录过滤参数填写指南了解如何填写 filter 参数。
400	1254024	InvalidFieldNames	field_names 参数错误。请检查接口中字段名称和多维表格中的字段名称是否完全匹配。如果难以排查，建议你调用列出字段接口获取字段名称，因为根据表格页面的 UI 名称可能会忽略空格、换行或特殊符号等差异
400	1254030	InvalidPageToken	分页游标错误
400	1254036	Bitable is copying, please try again later.	复制多维表格为异步操作，该错误码表示当前多维表格仍在复制中，在复制期间无法操作当前多维表格。需要等待复制完成后再操作
404	1254040	BaseTokenNotFound	app_token 不存在。不同形态的多维表格，其 `app_token` 的获取方式不同： - 如果多维表格的 URL 以 ==feishu.cn/base== 开头，该多维表格的 `app_token` 是下图高亮部分： - 如果多维表格的 URL 以 ==feishu.cn/wiki== 开头，你需调用知识库相关获取知识空间节点信息接口获取多维表格的 app_token。当 `obj_type` 的值为 `bitable` 时，`obj_token` 字段的值才是多维表格的 `app_token`。了解更多，参考多维表格 app_token 获取方式。
404	1254041	TableIdNotFound	table_id 不存在。获取方式： - 你可通过多维表格 URL 获取 `table_id`，下图高亮部分即为当前数据表的 `table_id` - 也可通过列出数据表接口获取 `table_id`
404	1254042	ViewIdNotFound	view_id 不存在。获取方式： - 在多维表格的 URL 地址栏中，`view_id` 是下图中高亮部分： - 通过列出视图接口获取。暂时无法获取到嵌入到云文档中的多维表格的 `view_id`。注意：当 `filter` 参数或 `sort` 参数不为空时，请求视为对数据表中的全部数据做条件过滤，指定的 `view_id` 会被忽略。
404	1254043	RecordIdNotFound	record_id 不存在。record_id 是数据表中一条记录的唯一标识。请通过查询记录接口获取。
404	1254044	FieldIdNotFound	field_id 不存在。field_id 是数据表中一个字段的唯一标识。通过列出字段接口获取。
404	1254045	FieldNameNotFound	字段名称不存在。请检查： - 接口中字段名称和多维表格中的字段名称是否完全匹配。如果难以排查，建议你调用列出字段接口获取字段名称，因为根据表格页面的 UI 名称可能会忽略空格、换行或特殊符号等差异。 - 表格是否开启了高级权限但调用身份缺少对应字段的权限。你需要为调用身份授予高级权限： - 对用户授予高级权限，你需要在多维表格页面右上方分享入口为当前用户添加可管理权限。 - 对应用授予高级权限，你需通过多维表格页面右上方「...」 -> 「...更多」 ->「添加文档应用」入口为应用添加可管理权限。注意：在添加文档应用前，你需确保目标应用至少开通了一个多维表格的 API 权限。否则你将无法在文档应用窗口搜索到目标应用。 - 你也可以在多维表格高级权限设置中添加用户或一个包含应用的群组, 给予这个群自定义的读写等权限。
500	1254060	TextFieldConvFail	多行文本字段错误
500	1254061	NumberFieldConvFail	数字字段错误
500	1254062	SingleSelectFieldConvFail	单选字段错误
500	1254063	MultiSelectFieldConvFail	多选字段错误
500	1254064	DatetimeFieldConvFail	日期字段错误
500	1254065	CheckboxFieldConvFail	复选框字段错误
500	1254066	UserFieldConvFail	人员字段有误。原因可能是： - `user_id_type` 参数指定的 ID 类型与传入的 ID 类型不匹配 - 传入了不识别的类型或结构，目前只支持填写 `id` 参数，且需要传入数组 - 跨应用传入了 `open_id`。如果跨应用传入 ID，建议使用 `user_id`。不同应用获取的 `open_id` 不能交叉使用 - 若想对人员字段传空，可传 null
500	1254067	LinkFieldConvFail	关联字段错误
500	1254068	URLFieldConvFail	超链接字段错误
500	1254069	AttachFieldConvFail	附件字段错误
400	1254072	Failed to convert phone field, please make sure it is correct.	电话字段错误
400	1254100	TableExceedLimit	数据表或仪表盘数量超限。每个多维表格中，数据表加仪表盘的数量最多为 100 个
400	1254101	ViewExceedLimit	视图数量超限, 限制 200 个
400	1254102	FileExceedLimit	文件数量超限
400	1254103	RecordExceedLimit	记录数量超限, 限制 20,000 条
400	1254104	RecordAddOnceExceedLimit	单次添加记录数量超限, 单次调用最多更新 1,000 条记录
400	1254107	FilterLengthExceedLimit	Filter长度超限, 限制 2,000 个字符
400	1254108	SortLengthExceedLimit	Sort 长度超限, 限制 1,000 个字符
400	1254109	FormulaTableSizeExceedLimit	公式表大小超限
400	1254130	TooLargeCell	格子内容过大
400	1254290	TooManyRequest	请求过快，稍后重试
400	1254291	LockNotObtainedError	在同一个数据表中，并发调用了读写接口或请求过快，出现冲突。请参考以下建议解决： - 确保没有并发调用多维表格读写相关接口 - 若操作量较大，建议在接口与接口之间增加 0.5 或 1 秒的延迟，也可在报错中增加重试逻辑，确保业务的稳定性 - 对于写接口，可以将接口中的查询参数 `ignore_consistency_check` 设置为 true，表示在读写操作时，暂时忽略一致性检查，以提高性能
400	1254301	OperationTypeError	多维表格未开启高级权限或不支持开启高级权限
400	1254302	RolePermNotAllow	无访问权限，常由表格开启了高级权限造成。请确保当前调用身份具有高级权限或多维表格的管理权限： - 对于应用身份，你需要通过云文档网页页面右上方「...」->「...更多」-> 「添加文档应用」入口添加并授予应用可管理权限，或在高级权限设置中添加一个包含应用的群组，给予这个群读写权限 - 对于用户身份，你需要通过云文档网页的「分享」入口授予用户管理权限了解更多，参考如何为应用或用户开通云文档权限。
400	1254303	AttachPermNotAllow	附件无权限
500	1255001	InternalError	内部错误，请联系技术支持
500	1255002	RpcError	内部错误，请联系技术支持
500	1255003	MarshalError	序列化错误，请联系技术支持
500	1255004	UmMarshalError	反序列化错误，请联系技术支持
500	1255005	ConvError	内部错误，请联系技术支持
504	1255040	Request timed out, please try again later	请求超时
500	1254607	Data not ready, please try again later	该报错一般是由于前置操作未执行完成，或本次操作数据太大，服务器计算超时导致。遇到该错误码时，建议等待一段时间后重试。通常有以下几种原因： - 编辑操作频繁：开发者对多维表格的编辑操作非常频繁。可能会导致由于等待前置操作处理完成耗时过长而超时的情况。多维表格底层对数据表的处理基于版本维度的串行方式，不支持并发。因此，并发请求时容易出现此类错误，不建议开发者对单个数据表进行并发请求。 - 批量操作负载重：开发者在多维表格中进行批量新增、删除等操作时，如果数据表的数据量非常大，可能会导致单次请求耗时过长，最终导致请求超时。建议开发者适当降低批量请求的 page_size 以减少请求耗时。 - 资源分配与计算开销：资源分配是基于单文档维度的，如果读接口涉及公式计算、排序等计算逻辑，会占用较多资源。例如，并发读取一个文档下的多个数据表也可能导致该文档阻塞。

26 KiB Raw Permalink Blame History Unescape Escape

批量获取记录

注意事项

请求

请求头

路径参数

请求体

请求体示例

响应

响应体

响应体示例

错误码

26 KiB

Raw Permalink Blame History