Actions11
- Node Actions
- Datasheet Actions
- Record Actions
- Field Actions
- View Actions
Record → Record List
AI-generatedOverview
This node interacts with the Apitable API to list records from a specified datasheet. It is useful for retrieving structured data stored in Apitable tables, supporting pagination, filtering, sorting, and field selection. Typical use cases include syncing Apitable data with other systems, reporting, or automating workflows based on table records.
For example, you can use this node to:
- Retrieve all records from a project management datasheet.
- Filter records where a status field equals "Completed".
- Sort records by a date field in descending order.
- Limit the output to specific fields like "Name" and "Due Date".
Properties
| Name | Meaning |
|---|---|
| Datasheet Id | The unique identifier of the Apitable datasheet from which to list records. This is required. |
| Additional Fields | Optional parameters to customize the record listing: - Page Size: Number of records per page (default 100). - Max Records: Maximum total records to return (default 1000). - Page Num: Page number to retrieve (default 1). - Sort: JSON object specifying sorting, e.g., `{ "field": "fieldname", "order": "asc |
Output
The node outputs an array of records in the json property of each item. Each record contains fields as key-value pairs according to the requested fields and format. If cellFormat is set to json, values retain their original types; if set to string, all values are converted to strings.
No binary data output is indicated.
Dependencies
- Requires an API key credential for authenticating with the Apitable API.
- Needs the base URL of the Apitable instance configured in credentials.
- Uses internal methods to load options dynamically for Datasheets and Views.
Troubleshooting
- Invalid Datasheet Id: Ensure the Datasheet Id is correct and accessible with your API key.
- API Authentication Errors: Verify that the API key credential is valid and has necessary permissions.
- Pagination Issues: If not all records appear, check
pageSize,maxRecords, andpageNumsettings. - Filter Syntax Errors: When using
filterByFormula, ensure the formula syntax matches Apitable's formula language. - Field Key Mismatch: If fields do not appear as expected, verify whether
fieldKeyis set tonameoridmatching your datasheet schema.