FeiShu Bitable Search icon

FeiShu Bitable Search

Search records in FeiShu Bitable

Overview

This node allows you to search records within a FeiShu Bitable app's table. It is useful for retrieving filtered, sorted, and paginated data from a specific table in a Bitable app. Common scenarios include automating workflows that require querying structured data stored in FeiShu Bitables, such as fetching customer records, inventory items, or project tasks based on certain criteria.

For example, you can use this node to:

  • Retrieve all records from a project management table sorted by due date.
  • Filter records in a customer database table where the status is "active".
  • Fetch a limited number of records from a sales table with specific fields returned.

Properties

Name Meaning
Sort Define multiple sorting rules to order the results by specific fields in ascending or descending order.
App Token The unique identifier (token) of the FeiShu Bitable app to query. This is required to specify which app contains the target table.
Table ID The unique identifier of the table within the Bitable app from which to retrieve records.
Return All Boolean flag indicating whether to return all matching records or limit the number of results.
Limit Maximum number of records to return when Return All is false. Must be at least 1.
Additional Fields A collection of optional parameters:
- View Name or ID: Specify a particular view of the table to filter or format the results.
- Field Names: Comma-separated list of field names to include in the output.
- Filter: JSON-formatted filter criteria to narrow down the search results.

Output

The node outputs an array of items, each containing a json object representing a single record retrieved from the specified FeiShu Bitable table. Each record includes the fields requested or available according to the input parameters.

  • If Return All is enabled, the node will paginate through all available records and return them all.
  • If Return All is disabled, it returns up to the specified Limit.
  • The output does not include binary data; it only returns JSON objects representing the records.

Dependencies

  • Requires an API authentication token credential for FeiShu Bitable API access.
  • Needs network access to FeiShu's open API endpoints.
  • The node internally obtains a tenant access token using the provided API credentials before making requests.
  • No additional external dependencies beyond the FeiShu API and n8n's HTTP request helper.

Troubleshooting

  • Failed to obtain tenant_access_token: Indicates issues with the provided API credentials or network connectivity. Verify that the API key/secret are correct and that the FeiShu API service is reachable.
  • Failed to fetch records: Could be caused by invalid table/app IDs, malformed filter JSON, or permission issues. Check that the App Token and Table ID are correct and that the filter JSON is valid.
  • Invalid filter JSON format: The filter property must be a valid JSON string. Use a JSON validator to ensure correctness.
  • If no records are returned, verify that the filter criteria and view settings match existing data.

Links and References

Discussion