list_records
Retrieve and manage records from specified AITable datasheets with pagination, field filtering, sorting, and formula-based filtering. Enables precise data extraction and organization for enhanced analysis.
Instructions
Read the records from a specified datasheet with support for pagination, field filtering, and sorting options.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fields | No | The returned record results are limited to the specified fields by name. Multiple fields should be separated by commas without spaces (e.g. 'field1,field2,field3'). | |
| filterByFormula | No | Filter the records by a formula. The formula should be in the format accepted by AITable, this is useful for filtering records based on specific criteria. e.g. '{field1}="value1"' or 'AND({field1}="value1", {field2}="value2")'. | |
| node_id | Yes | The ID of the datasheet to fetch records from. | |
| pageNum | No | Specifies the page number of the page, which is used in conjunction with the pageSize parameter. | |
| pageSize | No | How many records are returned per page. | |
| sort | No | Sort the returned records. | |
| viewId | No | When the viewId is explicitly specified, all records in the specified view will be returned in turn according to the sorting in the specified view. |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"fields": {
"description": "The returned record results are limited to the specified fields by name. Multiple fields should be separated by commas without spaces (e.g. 'field1,field2,field3').",
"type": "string"
},
"filterByFormula": {
"description": "Filter the records by a formula. The formula should be in the format accepted by AITable, this is useful for filtering records based on specific criteria. e.g. '{field1}=\"value1\"' or 'AND({field1}=\"value1\", {field2}=\"value2\")'.",
"type": "string"
},
"node_id": {
"description": "The ID of the datasheet to fetch records from.",
"type": "string"
},
"pageNum": {
"default": 1,
"description": "Specifies the page number of the page, which is used in conjunction with the pageSize parameter.",
"type": "number"
},
"pageSize": {
"default": 20,
"description": "How many records are returned per page.",
"maximum": 1000,
"minimum": 1,
"type": "number"
},
"sort": {
"description": "Sort the returned records.",
"items": {
"additionalProperties": false,
"properties": {
"field": {
"description": "field name",
"type": "string"
},
"order": {
"description": "Sorting order, must be 'asc' or 'desc'",
"enum": [
"asc",
"desc"
],
"type": "string"
}
},
"required": [
"field",
"order"
],
"type": "object"
},
"type": "array"
},
"viewId": {
"description": "When the viewId is explicitly specified, all records in the specified view will be returned in turn according to the sorting in the specified view.",
"type": "string"
}
},
"required": [
"node_id"
],
"type": "object"
}