Overview
This node integrates with FeiShu Bitable, a collaborative online database service. Specifically, the Record - Search operation allows users to query records from a specified table within a Bitable app. It supports filtering, sorting, and limiting the number of returned records.
Common scenarios include:
- Retrieving filtered datasets for reporting or further automation.
- Sorting records by one or multiple fields to prioritize or organize data.
- Fetching all or a limited subset of records based on user needs.
Practical example:
- A user wants to get all customer records from a sales table sorted by "Last Purchase Date" descending, filtered to only those with purchases in the last month.
Properties
| Name | Meaning |
|---|---|
| App Token | The unique identifier of the Bitable App to access. |
| Table ID | Unique identifier of the specific data table within the Bitable app. |
| 排序规则 (Sort) | Multiple sort rules to order the records by field(s). Each rule includes: |
| - Field Name or ID: Selectable list of fields or specify via expression. | |
| - Direction: Ascending or Descending order. | |
| Return All | Boolean flag indicating whether to return all matching results or limit the output. |
| Limit | Maximum number of records to return if not returning all. Minimum value is 1. |
| Additional Fields | Optional extra parameters: |
| - View Name or ID: Filter records by a specific view. | |
| - Field Names: Comma-separated list of specific fields to include in the output. | |
| - Filter: JSON-formatted filter criteria to narrow down search results. |
Output
The node outputs an array of record objects in the json field. Each object represents a record from the specified Bitable table, containing the requested fields and their values.
If binary data were supported (not indicated here), it would represent file attachments or media linked to records, but this node focuses on JSON data output.
Dependencies
- Requires an API authentication token (App Token) for the FeiShu Bitable app.
- Needs network access to FeiShu Bitable API endpoints.
- No additional external dependencies beyond standard n8n credentials and HTTP request capabilities.
Troubleshooting
- Invalid App Token or Table ID: Errors may occur if these identifiers are incorrect or expired. Verify tokens and IDs in FeiShu Bitable.
- Filter JSON Syntax Errors: Malformed JSON in the filter property will cause request failures. Use valid JSON format.
- Field or View Not Found: Selecting non-existent fields or views will result in errors. Ensure fields and views exist in the specified table.
- API Rate Limits: Excessive requests might be throttled by FeiShu Bitable API. Implement delays or reduce request frequency.
- Return All with Large Datasets: Returning all records can lead to performance issues or timeouts. Use limits when possible.