我们为开发者提供了一个内置的查询参数构建器,可以根据你的现有表格来构建自定义请求。

路径

GET /table/{tableId}/record ​

请求

路径参数

tableId (string): 表的唯一标识符(如何获取)

基础查询参数

所有参数均为可选

viewId
string

指定要获取的视图 ID。如果未指定,会按照创建时间来返回记录的顺序,并且返回所有记录和字段。

take
number

指定要获取的记录数量,最大值为 2000。

skip
number

指定要跳过的记录数量,用于分页。

fieldKeyType
string
default:
"name"

定义记录中字段的键类型,可选值:

  • name: 使用字段名称作为键(默认)
  • id: 使用字段 ID 作为键
cellFormat
string
default:
"json"

定义单元格返回值的格式,可选值:

  • json: 返回结构化的 JSON 数据(默认)
  • text: 返回纯文本格式
projection
string[]

如果只需要获取特定字段,可以通过此参数指定。否则将获取所有可见字段。参数值取决于 fieldKeyType 设置(使用字段名称或 ID)。

orderBy
string

指定记录排序方式的排序对象数组。

filter
string

用于筛选结果的复杂查询条件对象。支持基于字段、运算符和值的复杂查询条件。

搜索匹配指定字段和值的记录。