SmartSuite icon

SmartSuite

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

Actions9

Overview

This node integrates with the SmartSuite API to manage tables and records within SmartSuite solutions. Specifically, for the Table - Get operation, it retrieves detailed information about a specific table by its ID within a selected SmartSuite solution.

Typical use cases include:

  • Fetching metadata or structure of a particular table in a SmartSuite solution.
  • Retrieving table details before performing further operations like updating fields or creating new records.
  • Automating workflows that require dynamic access to table configurations.

For example, you might use this node to get the schema of a table to dynamically generate forms or validate data before inserting records.

Properties

Name Meaning
Solution Select the SmartSuite solution from which to retrieve the table.
Table ID The unique identifier of the table to retrieve within the selected solution.

Output

The node outputs a JSON object containing:

  • success: A boolean indicating if the request was successful (true).
  • data: The detailed information of the requested table, including its structure and metadata as returned by the SmartSuite API.
  • operation: The operation performed, here always "get".
  • resource: The resource type, here always "table".
  • solutionId: The ID of the SmartSuite solution used.

If multiple items are returned (not typical for a single table get), each item is wrapped similarly.

No binary data output is produced by this operation.

Example output JSON structure:

{
  "success": true,
  "data": {
    "id": "table-id",
    "name": "Table Name",
    "label": "Table Label",
    "description": "Description of the table",
    "icon": "icon-name",
    "structure": [
      {
        "name": "Field1",
        "field_type": "TEXT",
        ...
      },
      ...
    ],
    ...
  },
  "operation": "get",
  "resource": "table",
  "solutionId": "solution-id"
}

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 and applications (tables).
  • The user must have appropriate permissions in SmartSuite to access the specified solution and table.

Troubleshooting

  • Common issues:

    • Invalid or missing Solution ID or Table ID parameters will cause the API call to fail.
    • Insufficient permissions in SmartSuite may result in authorization errors.
    • Network connectivity issues can prevent communication with the SmartSuite API.

  • Error messages:

    • Errors returned from the API will be passed through in the node's output under the error field.
    • Typical error messages include "Not Found" if the table ID does not exist or "Unauthorized" if credentials are invalid.

  • Resolution tips:

    • Verify that the Solution and Table IDs are correct and exist in your SmartSuite account.
    • Ensure the API key credential has sufficient rights.
    • Check network connectivity and proxy settings if applicable.
    • Enable "Continue On Fail" in the node settings to handle errors gracefully in workflows.

Links and References

Discussion