SmartSuite icon

SmartSuite

Interact with SmartSuite API

Record → List Records

AI-generated

Overview

This node operation lists records from a specified table within a selected solution in SmartSuite. It is useful for retrieving multiple records, optionally with related data hydrated, and supports pagination control by allowing users to return all records or limit the number of records returned. Practical examples include fetching all customer records from a CRM table or retrieving a limited set of recent transactions from a financial table.

Use Case Examples

  1. List all records from the 'Projects' table in a specific solution, with related data hydrated for comprehensive details.
  2. Retrieve up to 50 records from the 'Tasks' table in a solution to display recent task entries.

Properties

Name Meaning
Solution Select the SmartSuite solution from which to list records. This can be chosen from a list or specified by ID.
Table Select the table within the chosen solution from which to list records. This can be chosen from a list or specified by ID.
Hydrated Boolean option to return records with related data hydrated, providing more detailed and connected information.
Return All Boolean option to return all records, ignoring the limit setting.
Limit Maximum number of records to return when 'Return All' is false. The value ranges from 1 to 100.

Output

JSON

  • records - Array of record objects retrieved from the specified table.
  • totalCount - Total number of records available in the table (if provided by the API).

Dependencies

  • SmartSuite API with an API key credential for authentication

Troubleshooting

  • Ensure the selected solution and table IDs are correct and accessible with the provided credentials.
  • If the node returns no records, verify that the table contains data and that any filters or hydration options are correctly set.
  • Connection errors may indicate issues with API credentials or network connectivity; re-test the credentials and check network settings.

Links

Discussion