SmartSuite icon

SmartSuite

Interact with SmartSuite API to manage records, search data, and perform operations on your SmartSuite solutions.

Actions9

Overview

This node interacts with the SmartSuite API to manage and retrieve records within a specified SmartSuite solution and table. Specifically, the Record - List operation fetches multiple records from a selected table in a SmartSuite solution. It supports returning either basic record data or "hydrated" records that include full field details.

Common scenarios where this node is beneficial include:

  • Retrieving all records from a particular table for reporting or further processing.
  • Fetching enriched record data (hydrated) when detailed field information is required.
  • Integrating SmartSuite data into workflows for automation, such as syncing records with other systems.

Practical example:

  • A user wants to list all customer records from a "Customers" table in their SmartSuite solution to generate a mailing list.
  • Another use case is fetching fully detailed project records (hydrated) to analyze project statuses and deadlines.

Properties

Name Meaning
Solution Select a SmartSuite Solution from which to list records.
Table Select a Table within the chosen Solution to list records from.
Hydrated Boolean option to return hydrated records with full field data (true) or just basic data (false).

Output

The output JSON structure contains:

  • success: Boolean indicating if the operation was successful.
  • data: The actual record data returned by the API. For the List operation, this is an array of records.
  • operation: The operation performed, here always "list".
  • resource: The resource type, here "record".
  • solutionId: The ID of the SmartSuite solution used.
  • tableId: The ID of the table from which records were listed.

Each record in data includes fields as provided by the SmartSuite API. If hydrated is true, records contain full field details; otherwise, they contain basic record information.

No binary data output is indicated for 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.
  • The node uses internal helper functions to make authenticated HTTP requests to SmartSuite.

Troubleshooting

  • Common issues:

    • Invalid or missing Solution or Table IDs will cause API errors.
    • Network connectivity problems can prevent API calls.
    • Insufficient permissions on the API key may result in authorization errors.
    • Requesting hydrated records may fail if the API does not support hydration for certain tables.

  • Error messages:

    • Errors returned from the API are captured and included in the output under error.
    • Typical error messages might include "Not Found" (invalid IDs), "Unauthorized" (bad credentials), or "Bad Request" (invalid parameters).

  • Resolutions:

    • Verify that the Solution and Table selections are correct and accessible.
    • Ensure the API key has sufficient permissions.
    • Check network connectivity.
    • Use the non-hydrated option if hydration causes issues.

Links and References

Discussion