SmartSuite icon

SmartSuite

Interact with SmartSuite API

Actions21

Record → Search Records

AI-generated

Overview

This node operation allows users to search records within a specified solution and table in SmartSuite. It supports applying multiple filters combined with AND/OR operators to refine the search results. Users can choose to return hydrated records (with expanded related data), limit the number of results, or return all matching records. This is useful for scenarios where you need to query and retrieve specific records based on dynamic criteria, such as filtering customer data, searching for tasks with certain statuses, or extracting records matching complex conditions.

Use Case Examples

  1. Search for all records in a project management table where the status is 'In Progress' and priority is 'High'.
  2. Retrieve all customer records from a CRM solution that match certain filter criteria, such as location or purchase history.
  3. Fetch all records from a table with hydrated data to include related entity details for comprehensive reporting.

Properties

Name Meaning
Solution Select the SmartSuite solution to search records in. This is required to specify the context of the data.
Table Select the table within the chosen solution to search records from. This is required to specify the dataset.
Search Operator Choose how to combine multiple filters: using AND (all conditions must be met) or OR (any condition can be met).
Filters A collection of filter criteria to apply to the search. Each filter includes a field, a condition (comparison operator), and a value to compare against. Multiple filters can be added and sorted.
Hydrated Boolean option to return hydrated records, which include expanded related data rather than just raw record fields.
Return All Boolean option to ignore the limit and return all matching records.
Limit Maximum number of records to return if 'Return All' is false. The limit ranges from 1 to 100.

Output

JSON

  • records - Array of record objects matching the search criteria.
  • totalCount - Total number of records found matching the filters.

Dependencies

  • SmartSuite API with an API key credential

Troubleshooting

  • Ensure the selected solution and table IDs are correct and accessible with the provided API credentials.
  • Verify that filter fields and conditions are valid for the selected table schema to avoid errors.
  • If no records are returned, check the filter criteria and search operator to ensure they match existing data.
  • API rate limits or connectivity issues may cause errors; verify network and credential status.

Links

Discussion