查询记录
... 2026-2-4 大约 1 分钟
# 查询记录
# 接口说明
本接口用于获取 Smartsheet 中某个子表下记录信息，该接口可以完成下面三种功能：获取全部记录信息、依据字段名和记录 ID 获取对应记录、对记录进行排序。
# 请求格式
| 描述 | 定义 |
|---|---|
| Path | /openapi/smartsheet/v2/files/{fileID}/sheets/{sheetID}/records:list |
| Method | POST |
| Content-Type | application/json |
| Accept | application/json |
# 请求头部
详见Headers。
# 请求参数
# 查询参数
无
# 请求体
| 参数名 | 类型 | 必选 | 描述 |
|---|---|---|---|
| getRecords | JSON Object(GetRecordsRequest) | 是 | 查询记录请求 |
# 响应参数
# 请求体
| 参数名 | 类型 | 描述 |
|---|---|---|
| ret | integer | 业务返回码 |
| msg | string | 业务返回码描述 |
| data.getRecords | JSON Object(GetRecordsResponse) | 查询记录响应 |
# 请求包体
POST /openapi/smartsheet/v2/files/DAAAAAAAAAAAA/sheets/at5j8y/records:list HTTP/1.1
Access-Token: ACCESS_TOKEN
Client-Id: CLIENT_ID
Content-Type: application/json
Content-Length: 1
{'getRecords': {'offset': 0, 'limit': 5}}
1
2
3
4
5
6
7
2
3
4
5
6
7
1
2
3
4
5
6
7
2
3
4
5
6
7
# 示例
curl --location --request POST 'https://{domain}/openapi/smartsheet/v2/files/DAAAAAAAAAAAA/sheets/at5j8y/records:list' \
--header 'Access-Token: ACCESS_TOKEN' \
--header 'Client-Id: CLIENT_ID' \
--header 'Content-Type: application/json' \
--data-raw '{
"getRecords": {
"offset": 0,
"limit": 5
}
}'
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10