Definition and Usage
Search for records in a Lark Base table either by referencing a specific view or by applying a filter formula across all records. You can locate tables and views by name or by their unique IDs. Use “By View” to return records exactly as configured in a view (including its filters/sorts in Lark Base). Use “By Filter” to search the entire table using a custom filter formula.
Parameter Values
Input Parameters
Parameter Name | Description | Possible Values | Required | Options / Notes |
Lark Base | The connected Lark Base instance to run the query against. | Lark Base object | Yes | Create/connect with “Connect Lark Base” before using. |
Table locating mode | How to specify which table to query. | By name, By ID | Yes | Choose “By ID” for reliability; names can change. |
Data table name | The table’s name to query. | Text | Yes* | Required when Table locating mode = By name. |
Data table ID | The table’s unique ID to query. | Text | Yes* | Required when Table locating mode = By ID. |
Query mode | How to define which records to return. | By View, By Filter | Yes | “By View” returns records in a chosen view; “By Filter” uses a filter formula. |
View locating mode | How to specify the view when using “By View”. | By name, By ID | Yes* | Required only if Query mode = By View. |
View name | The view’s name to query. | Text | Yes* | Required when Query mode = By View and View locating mode = By name. |
View ID | The view’s unique ID to query. | Text | Yes* | Required when Query mode = By View and View locating mode = By ID. |
Filter formula | A filter expression to select records when using “By Filter”. | Text | Yes* | Required when Query mode = By Filter; follow Lark Base filter syntax. |
Obtained fields | Fields to include in the output, separated by semicolons. | Field list (semicolon) | No | Leave blank to return all available fields; use exact field names. |
Advanced Settings
No advanced settings available.
Error Handling
Parameter Name | Description |
Throw error & stop | When an error occurs, the action will stop execution. |
Retry command | The action retries the command if an error occurs. |
Ignore error & continue | The action ignores the error and continues workflow execution. |
Variables Produced
This action outputs the queried records into a variable you choose. You can pass this variable to later steps to iterate over records, extract field values, or perform updates and exports.
Using Variables in Conditions
You can use variables to pass dynamic values from previous steps into fields such as table/view identifiers, filter formulas, and field lists. If the UI marks options with {x}, those fields support variables. Typical usage includes building filter formulas from prior step outputs or switching tables/views based on earlier selections.
Notes
Ensure you have already connected to Lark Base before running this command.
Prefer locating by ID to avoid failures when names change or contain special characters.
For “By View”, confirm the view exists in the selected table; view IDs can be copied from the Base URL.
For “By Filter”, validate your filter formula against Lark Base syntax to avoid empty results or errors.
Use exact field names in “Obtained fields”; separate multiple fields with semicolons and avoid trailing spaces.
If no fields are specified, the command may return all fields, which can increase data volume.