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 node interacts with Lark Sheets, specifically to obtain a filter view from a given sheet within a spreadsheet. This operation is useful when you want to programmatically retrieve the configuration or details of a filter view applied on a sheet, such as for reporting, automation, or integration purposes.
Common scenarios include:
- Automating data extraction workflows where filtered views are needed.
- Integrating Lark Sheets filter configurations into other systems.
- Auditing or backing up filter views programmatically.
For example, a user might use this node to fetch the current filter settings on a sales report sheet to generate customized reports based on those filters.
Properties
| Name | Meaning |
|---|---|
| Authentication | Method of authentication to access Lark Sheets API. Options: Tenant Token, OAuth2. |
| Spreadsheet Token | The unique token identifying the target spreadsheet. |
| Sheet Id | The identifier of the specific sheet within the spreadsheet. |
| Filter View Id | The identifier of the filter view to be obtained from the specified sheet. |
| Options | Additional options for the request. Currently supports "Use Custom Body" (boolean). |
Output
The node outputs JSON data representing the details of the requested filter view. This typically includes the filter criteria, columns involved, and any other metadata defining the filter view's configuration.
If binary data were involved (not indicated here), it would represent file contents or attachments related to the filter view, but in this case, output is purely JSON describing the filter view.
Dependencies
- Requires access to Lark Suite APIs via an authenticated connection.
- Needs either a tenant token or OAuth2 credentials configured in n8n to authenticate API requests.
- Network connectivity to
https://open.larksuite.com/open-apisis required.
Troubleshooting
- Invalid Credentials: If authentication fails, verify that the provided tenant token or OAuth2 credentials are valid and have sufficient permissions.
- Incorrect IDs: Errors may occur if the spreadsheet token, sheet ID, or filter view ID are incorrect or do not exist. Double-check these values.
- API Rate Limits: Frequent calls may hit rate limits imposed by Lark Suite; consider adding delays or retries.
- Network Issues: Ensure stable internet connection and that the Lark Suite API endpoint is reachable.
Common error messages will generally indicate authentication failure, resource not found, or permission denied. Resolving them involves checking credentials, verifying IDs, and ensuring proper API access rights.