Actions23
- Spreadsheet Actions
- Sheet Filter Actions
- Sheet Filter View Actions
- Filter Condition Filter View Actions
- Sheet Row Column Actions
- Sheet Data Actions
- Sheet Floating Image Actions
Overview
The "Search" operation under the "Sheet Data" resource in this node allows users to search for specific content within a sheet of a spreadsheet managed by Lark Sheets. This operation is useful when you want to locate cells containing particular text, formulas, or patterns within a defined range or the entire sheet.
Common scenarios include:
- Finding all occurrences of a keyword or phrase in a sheet.
- Searching for cells that match a regular expression pattern.
- Locating formulas or values with case sensitivity or whole-cell matching.
- Filtering data dynamically based on search criteria before further processing.
For example, you might use this node to find all rows where a customer's name appears exactly as entered, or to identify cells containing formulas for auditing purposes.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authentication to access the Lark Sheets API. Options: Tenant Token, OAuth2. |
| Spreadsheet Token | The unique token identifying the spreadsheet to search within. |
| Sheet Id | The identifier of the specific sheet inside the spreadsheet where the search will be performed. |
| Find | The string or pattern to search for in the sheet. |
| Find Condition | A collection of options refining the search behavior: - include_formulas: Whether to include formulas in the search. - match_case: Whether the search is case-sensitive. - match_entire_cell: Whether to match the entire cell content. - range: Specific range within the sheet to limit the search. - search_by_regex: Whether to interpret the find string as a regular expression. |
| Custom Body | Allows sending a fully custom JSON body for the search request, overriding other parameters. Useful for advanced or unsupported search configurations. |
| Options > Use Custom Body | Boolean flag to enable using the Custom Body property instead of the standard parameters. |
Output
The node outputs JSON data representing the search results from the specified sheet. The structure typically includes details about matched cells such as their location (row and column), content, and possibly metadata like whether the content is a formula.
If binary data were involved (e.g., exporting matched cells as files), it would be indicated here, but this operation focuses on JSON search results only.
Dependencies
- Requires access to the Lark Sheets API via an authenticated connection.
- Users must provide either a Tenant Token or OAuth2 credentials configured in n8n.
- The node sends requests to
https://open.larksuite.com/open-apis. - Proper permissions on the spreadsheet and sheet are necessary to perform searches.
Troubleshooting
- Authentication errors: Ensure that the provided API key or OAuth2 token is valid and has sufficient permissions.
- Invalid Spreadsheet Token or Sheet Id: Double-check these identifiers; incorrect values will cause the API to fail to locate the target sheet.
- Malformed regular expressions: If using regex search, ensure the pattern syntax is correct to avoid errors.
- Empty or no matches found: Verify the search string and conditions; consider toggling case sensitivity or entire cell matching.
- Custom Body usage: When enabling "Use Custom Body," ensure the JSON is correctly formatted and contains all required fields, as the node bypasses standard validation.