Actions13
Table → List Records
AI-generatedOverview
This node operation allows you to list records from a specified table in the Tulip platform. It is useful when you want to retrieve multiple entries from a database table, optionally filtered, sorted, and paginated. Common scenarios include fetching recent orders, filtering user data based on criteria, or exporting subsets of data for reporting.
For example, you could use this node to:
- Retrieve the first 10 records from a "Customers" table.
- Get all records where the "Status" column equals "Active".
- Sort records by "Created Date" in descending order.
- Include the total count of matching records for pagination purposes.
Properties
| Name | Meaning |
|---|---|
| Table Name or ID | Select the target table from a dropdown list or specify its ID via an expression. This determines which table's records will be listed. |
| Include Total Count | Boolean flag to include the total number of matching records in the response header. Enabling this triggers an additional query that may impact performance but provides the total count useful for pagination. |
| Limit | Maximum number of records to return in the response. Controls page size for pagination. |
| Offset | Number of records to skip before starting to return results. Useful for paging through large datasets. |
| Sort Options | One or more sorting rules specifying which columns to sort by and whether to sort ascending or descending. Allows ordering the returned records. |
| Filters | One or more filter conditions to restrict which records are returned. Each filter specifies a column, a comparison function (e.g., equal, contains, greater than), and a value if applicable. |
| Filter aggregator | Defines how multiple filters are combined: "all" means every filter must match (logical AND), "any" means at least one filter must match (logical OR). |
Output
The output consists of JSON objects representing the records retrieved from the specified table. Each record includes fields corresponding to the table's columns with their respective values.
If the "Include Total Count" option is enabled, the total number of matching records is available in the response headers (not directly in the JSON output).
No binary data output is produced by this operation.
Dependencies
- Requires connection to the Tulip API with valid authentication credentials (an API key or token).
- The node depends on the Tulip platform's tables and their schema being accessible.
- No additional external services are required beyond the Tulip API.
Troubleshooting
- Empty Results: If no records are returned, verify that the table ID is correct and that any filters applied actually match existing records.
- Invalid Table or Column IDs: Selecting or specifying invalid table or column identifiers will cause errors. Use the provided dropdowns or ensure expressions resolve correctly.
- Performance Issues: Enabling "Include Total Count" can slow down responses due to extra queries; disable it if not needed.
- Filter Syntax Errors: Ensure filter functions and values are compatible with the column data types.
- API Authentication Errors: Confirm that the API credentials are valid and have sufficient permissions to read table data.
Links and References
- Tulip API Documentation — Official API reference for understanding table and record operations.
- n8n Expressions — Guide on using expressions to dynamically set property values such as table or column IDs.