Smartsheet icon

Smartsheet

Consume Smartsheet API

Overview

This node interacts with the Smartsheet API to fetch all columns from a specified sheet. It is useful for workflows where you need to retrieve metadata about the columns in a Smartsheet, such as their names, types, and other properties. Common scenarios include dynamically mapping data to columns, validating sheet structure before data import, or generating reports based on column definitions.

Practical examples:

  • Listing all columns of a project tracking sheet to prepare for automated row insertion.
  • Validating that required columns exist before updating sheet data.
  • Extracting column information for documentation or integration purposes.

Properties

Name Meaning
Sheet ID of the sheet whose columns will be fetched. You must select an existing sheet.
Validation (Only shown for PICKLIST type columns) Boolean flag to enable or disable validation.

Output

The output is a JSON array where each item represents a column from the selected sheet. Each object typically includes:

  • id: The unique identifier of the column.
  • title: The name of the column.
  • type: The data type of the column (e.g., TEXT_NUMBER, DATE, PICKLIST).
  • Additional metadata fields as provided by the Smartsheet API (such as index, symbol, options for picklists, etc.).

Example output:

[
  {
    "id": 123456789,
    "title": "Task Name",
    "type": "TEXT_NUMBER",
    "index": 0,
    "primary": true
  },
  {
    "id": 987654321,
    "title": "Status",
    "type": "PICKLIST",
    "options": ["Not Started", "In Progress", "Complete"],
    "validation": false
  }
]

Dependencies

  • External Service: Requires access to the Smartsheet API.
  • API Key: You must configure n8n with valid Smartsheet API credentials (smartsheetApi).
  • n8n Configuration: No additional environment variables are needed beyond standard credential setup.

Troubleshooting

  • Missing or Invalid Sheet: If the selected sheet does not exist or the ID is incorrect, the node may throw an error indicating the sheet was not found. Ensure the "Sheet" property is set to a valid, accessible sheet.
  • Authentication Errors: If your API key is missing or invalid, you may receive authentication errors. Double-check your Smartsheet credentials in n8n.
  • Insufficient Permissions: If your Smartsheet account lacks permission to view the sheet or its columns, the node will fail. Make sure your account has at least viewer access to the target sheet.
  • API Rate Limits: Excessive requests to the Smartsheet API may result in rate limit errors. If this occurs, try reducing the frequency of node execution.

Links and References

Discussion