Overview
The node enables searching records within a specified table of a SmartSuite solution using flexible filter criteria. It allows users to define multiple filters combined with either an AND or OR operator, facilitating complex queries on record data.
This operation is beneficial when you need to retrieve records matching specific conditions from large datasets in SmartSuite, such as filtering tasks by status and due date or finding contacts with certain attributes.
Example use cases:
- Search for all records where the "Status" field equals "Completed" AND the "Priority" field is "High".
- Find records where the "Name" field contains "Smith" OR the "Email" field ends with "@example.com".
Properties
| Name | Meaning |
|---|---|
| Solution | Select the SmartSuite Solution containing the target table. |
| Table | Select the Table within the chosen Solution to search records in. |
| Hydrated | Boolean flag indicating whether to return hydrated records with full field data (true) or minimal data (false). |
| Search Operator | Logical operator to combine multiple filters: AND means all filters must match; OR means any filter can match. |
| Filters | One or more filters to apply in the search. Each filter includes: - Field: The field to filter on. - Condition: The comparison condition (e.g., equals, contains, greater than). - Value: The value to compare against (not required for empty/not empty conditions). |
Filter Conditions Available
- Contains
- Does Not Contain
- Equals
- Not Equals
- Starts With
- Ends With
- Greater Than
- Less Than
- Between
- Is (date equality)
- Is Not (date inequality)
- Is Before (date)
- Is After (date)
- Is Between (dates)
- Is Empty
- Is Not Empty
Output
The output JSON object for each returned record has the following structure:
{
"success": true,
"data": { /* record data object */ },
"operation": "search",
"resource": "record",
"solutionId": "<Solution ID>",
"tableId": "<Table ID>"
}
success: Indicates if the search was successful.data: Contains the record(s) returned by the search. This can be a single record object or an array of records depending on the API response.operation,resource,solutionId,tableId: Metadata about the performed operation and context.
If the "Hydrated" option is enabled, the data will include full field details for each record.
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to the SmartSuite API via an API key credential configured in n8n.
- The node depends on the SmartSuite API endpoints for solutions, tables, and records.
- Proper permissions on the SmartSuite account are necessary to perform searches on the specified solution and table.
Troubleshooting
- Empty results: Verify that the selected Solution and Table IDs are correct and contain records matching the filters.
- Invalid filters: Ensure that the fields used in filters exist in the selected table and that the condition matches the field type (e.g., do not use "Contains" on number fields).
- API errors: Common errors may include authentication failures (check API key validity), permission issues, or rate limits imposed by SmartSuite.
- Incorrect hydration flag: If full record details are expected but missing, confirm that the "Hydrated" property is set to true.
- Filter value missing: For conditions other than "Is Empty" or "Is Not Empty", ensure a value is provided; otherwise, the filter will be invalid.
Links and References
- SmartSuite API Documentation (for detailed API usage and field types)
- n8n Documentation (for general guidance on using the SmartSuite node)