Smartsheet Component

Manage sheets, rows, and workspaces in the Smartsheet platform

Component key: smartsheet · Changelog ↓

Description

Smartsheet is a software as a service offering for collaboration and work management, developed and marketed by Smartsheet Inc. This component allows managing and interacting with Smartsheet sheets.

API Documentation

This component was built using the Smartsheet API Documentation

This component wraps the most popular endpoints listed in the Smartsheet API docs. For access to an endpoint not covered by an action in this component, use the Raw Request action to issue a GET, POST, PUT or DELETE against any Smartsheet API endpoint.

A Note on Webhooks

It is recommended to create and configure webhooks in a flow triggered at Instance Deploy using the Create Webhook action. That action can be configured to create a webhook for a given sheet and can reference the trigger's payload to fetch sibling flows' webhook URLs.

To remove webhooks, use the built-in Delete Instance Webhooks action to delete all webhooks in Smartsheet that point to a flow of the current instance.

Connections

API Key

key: apiKey

API keys can be used for development purposes, though an OAuth 2.0 connection is recommended for production integrations.

Refer to the Smartsheet API key documentation for instructions on generating an API key.

Configure the Connection

Create a connection of type API Key and configure the following fields:

Base URL: Select the Smartsheet API base URL. Most applications use the commercial endpoint. Government entities should select the government endpoint.
API Key: Enter the API key generated from the Smartsheet account settings.

Input	Notes	Example
API Key	The API key generated from the Smartsheet account settings.
Base URL	Most applications use Smartsheet commercial. Government entities should select the government endpoint.	https://api.smartsheet.com/2.0/

OAuth 2.0 (Deprecated)

key: Smartsheet OAuth2

Deprecation Notice

This connection type is deprecated. Use the OAuth 2.0 connection instead, which provides a simplified configuration with templated URLs.

To authenticate with Smartsheet through OAuth 2.0, create and configure an app within the Smartsheet account.

Prerequisites

A Smartsheet account with access to Developer Tools
A developer profile created in Smartsheet

Setup Steps

Log in to Smartsheet
Navigate to the profile icon (bottom left) and select Developer Tools
Create a developer profile if one does not already exist
Click Create New App
Configure the app:
- App Name: Enter the application name
- App Description: Add a brief description
- App Logo: Optional
- Publish App: Leave unchecked (not required)
- App Redirect URL: Enter https://oauth2.prismatic.io/callback
Save the app and note the generated credentials:
- App Client ID
- App Secret

Configure the Connection

Create a connection of type OAuth 2.0 (Deprecated) and configure the following fields:

Base URL: Select the Smartsheet API base URL. Most applications use the commercial endpoint. Government entities should select the government endpoint.
Authorization URL: Select the OAuth 2.0 authorization endpoint for Smartsheet.
Token URL: Select the OAuth 2.0 token exchange endpoint for Smartsheet.
Scopes: A space-separated list of permissions to request. Remove any permissions not needed. Refer to the available scopes documentation for details.
App Client ID: Enter the client ID generated from the Smartsheet app.
App Secret: Enter the client secret generated from the Smartsheet app.

Input	Notes	Example
Authorization URL	The OAuth 2.0 authorization endpoint for Smartsheet.	https://app.smartsheet.com/b/authorize
Base URL	Most applications use Smartsheet commercial. Government entities should select the government endpoint.	https://api.smartsheet.com/2.0/
App Client ID	The client ID generated when creating an app within Smartsheet's Developer Tools.	abcdefghijklmnop123
App Secret	The client secret generated when creating an app within Smartsheet's Developer Tools.	abcdefghijklmnop123
Scopes	A space-separated list of permissions to request. Remove any permissions not needed. See available scopes for details.	ADMIN_SHEETS ADMIN_SIGHTS ADMIN_USERS ADMIN_WEBHOOKS ADMIN_WORKSPACES CREATE_SHEETS CREATE_SIGHTS DELETE_SHEETS DELETE_SIGHTS READ_CONTACTS READ_EVENTS READ_SHEETS READ_SIGHTS READ_USERS SHARE_SHEETS SHARE_SIGHTS WRITE_SHEETS
Token URL	The OAuth 2.0 token exchange endpoint for Smartsheet.	https://api.smartsheet.com/2.0/token

OAuth 2.0

key: templatedOAuth

To authenticate with Smartsheet through OAuth 2.0, create and configure an app within the Smartsheet account.

Prerequisites

A Smartsheet account with access to Developer Tools
A developer profile created in Smartsheet

Setup Steps

Log in to Smartsheet
Navigate to the profile icon (bottom left) and select Developer Tools
Create a developer profile if one does not already exist
Click Create New App
Configure the app:
- App Name: Enter the application name
- App Description: Add a brief description
- App Logo: Optional
- Publish App: Leave unchecked (not required)
- App Redirect URL: Enter https://oauth2.prismatic.io/callback
Save the app and note the generated credentials:
- App Client ID
- App Secret

Configure the Connection

Create a connection of type OAuth 2.0 and configure the following fields:

API Domain: Select the Smartsheet API domain. Most applications use the commercial domain (api.smartsheet.com). Government entities should select the government endpoint (api.smartsheetgov.com).
App Domain: Select the Smartsheet application domain. This should match the API domain selection.
Scopes: A space-separated list of permissions to request. Remove any permissions not needed. Refer to the available scopes documentation for details.
App Client ID: Enter the client ID generated from the Smartsheet app.
App Secret: Enter the client secret generated from the Smartsheet app.

Input	Notes	Example
API Domain	Select the Smartsheet API domain. Most applications use commercial, but government entities should use the government endpoint.	api.smartsheet.com
App Domain	Select the Smartsheet application domain. This should match your API domain selection.	app.smartsheet.com
Authorize URL	The OAuth 2.0 Authorization URL for Smartsheet	https://{{#appDomain}}/b/authorize
Base URL	The base URL for the Smartsheet API	https://{{#apiDomain}}/2.0/
App Client ID	The client ID generated when creating an app within Smartsheet's Developer Tools.	abcdefghijklmnop123
App Secret	The client secret generated when creating an app within Smartsheet's Developer Tools.	abcdefghijklmnop123
Scopes	A space-separated list of permissions to request. Remove any permissions not needed. See available scopes for details.	ADMIN_SHEETS ADMIN_SIGHTS ADMIN_USERS ADMIN_WEBHOOKS ADMIN_WORKSPACES CREATE_SHEETS CREATE_SIGHTS DELETE_SHEETS DELETE_SIGHTS READ_CONTACTS READ_EVENTS READ_SHEETS READ_SIGHTS READ_USERS SHARE_SHEETS SHARE_SIGHTS WRITE_SHEETS
Token URL	The OAuth 2.0 Token URL for Smartsheet	https://{{#apiDomain}}/2.0/token

Triggers

Webhook

Receive and validate webhook requests from Smartsheet for manually configured webhook subscriptions. | key: smartsheetWebhook

A Smartsheet webhook can be configured to send information to a flow's webhook URL under certain conditions (a "Column" is updated, a "Row" is deleted, etc.).

How It Works

When a webhook is first configured, Smartsheet sends a confirmation request to the webhook endpoint. This request is passed into the URL Verify branch beneath the trigger. The trigger automatically handles the challenge response required by Smartsheet.

All subsequent webhook requests are routed to the Event branch.

Configuration

To configure a webhook, use the Create Webhook action and reference a sibling flow's webhook URL by referencing the trigger's payload.

Data Sources

Select Attachment

Select an attachment from a specific sheet. | key: selectAttachment | type: picklist

Input	Notes	Example
Connection	The Smartsheet connection to use.
Sheet ID	The unique identifier for the sheet.	4583173393803140

Select Column

Select a column from a specific sheet. | key: selectColumn | type: picklist

Input	Notes	Example
Connection	The Smartsheet connection to use.
Sheet ID	The unique identifier for the sheet.	4583173393803140

Select Contact

Select a contact from the Smartsheet account. | key: selectContact | type: picklist

Input	Notes	Example
Connection	The Smartsheet connection to use.

Select Discussion

Select a discussion from a specific sheet. | key: selectDiscussion | type: picklist

Input	Notes	Example
Connection	The Smartsheet connection to use.
Sheet ID	The unique identifier for the sheet.	4583173393803140

Select Folder

Select a folder from the Smartsheet home or workspace. | key: selectFolder | type: picklist

Input	Notes	Example
Connection	The Smartsheet connection to use.

Select Group

Select a group from the Smartsheet account. | key: selectGroup | type: picklist

Input	Notes	Example
Connection	The Smartsheet connection to use.

Select Report

Select a report from the Smartsheet account. | key: selectReport | type: picklist

Input	Notes	Example
Connection	The Smartsheet connection to use.

Select Row

Select a row from a specific sheet. | key: selectRow | type: picklist

Input	Notes	Example
Connection	The Smartsheet connection to use.
Sheet ID	The unique identifier for the sheet.	4583173393803140

Select Sheet

Select a sheet from the Smartsheet account. | key: selectSheet | type: picklist

Input	Notes	Example
Connection	The Smartsheet connection to use.

Select User

Select a user from the Smartsheet account. | key: selectUser | type: picklist

Input	Notes	Example
Connection	The Smartsheet connection to use.

Select Webhook

Select a webhook from the Smartsheet account. | key: selectWebhook | type: picklist

Input	Notes	Example
Connection	The Smartsheet connection to use.

Select Workspace

Select a workspace from the Smartsheet account. | key: selectWorkspace | type: picklist

Input	Notes	Example
Connection	The Smartsheet connection to use.

Actions

Add Column to Sheet

Adds a column to a sheet. | key: columnsAddToSheet

Input	Notes	Example
Connection	The Smartsheet connection to use.
Description	Additional context or instructions displayed below the column header.
Formula	The formula for a column.
Hidden	Indicates whether the column is hidden	false
Position Index	The 0-based position where the column should be inserted in the sheet.	0
Locked	Indicates whether the column is locked	false
Options	A list of options for picklists
Sheet ID	The unique identifier for the sheet.	4583173393803140
Title	The display name for the column header.
Type	The data type for the column. Determines how cell values are displayed and validated.
Validation	Indicates whether validation has been enabled for the column	false
Width	Display width of the column in pixels.

{
  "data": {
    "message": "SUCCESS",
    "resultCode": 0,
    "result": [
      {
        "id": 9007194052434043,
        "index": 4,
        "title": "New Picklist Column 1",
        "type": "PICKLIST",
        "options": [
          "First",
          "Second",
          "Third"
        ],
        "validation": false,
        "width": 150
      }
    ]
  }
}

Add Comment

Adds a comment to a discussion. | key: commentsCreate

Input	Notes	Example
Connection	The Smartsheet connection to use.
Discussion ID	The unique identifier for the discussion.	3650061106619268
Sheet ID	The unique identifier for the sheet.	4583173393803140
Text	The text content of the comment.

{
  "data": {
    "message": "SUCCESS",
    "result": {
      "createdAt": "2013-02-28T22:58:30-08:00",
      "createdBy": {
        "email": "john.doe@smartsheet.com",
        "name": "John Doe"
      },
      "id": 6834973207488388,
      "modifiedAt": "2013-02-28T22:58:30-08:00",
      "text": "This is a new comment."
    },
    "resultCode": 0
  }
}

Add/Update Row

Adds or updates a row on a sheet. | key: rowsAddToSheet

Input	Notes	Example
Allow Partial Success	When specified with a value of true, enables partial success for this bulk operation	false
Column Values	A list of columns to be updated with the specified value
Connection	The Smartsheet connection to use.
Dynamic Columns Values	List of columns and their values
Override Validation	When true, allows cell values outside of the validation limits defined on the column.	false
Row Position (for new rows)	The position where new rows are added to the sheet.	toBottom
Sheet ID	The unique identifier for the sheet.	4583173393803140
Row ID (Optional)	An ID of a row to update. Omit to add a new row	8908091207493508

{
  "data": {
    "message": "SUCCESS",
    "resultCode": 0,
    "result": [
      {
        "id": 3987537850460036,
        "rowNumber": 1,
        "expanded": true,
        "createdAt": "2022-07-01T19:02:57Z",
        "modifiedAt": "2022-07-01T19:02:58Z",
        "cells": [
          {
            "columnId": 4902035581626244,
            "value": false
          },
          {
            "columnId": 2650235767940996,
            "value": "New Value",
            "displayValue": "New Value"
          }
        ]
      }
    ],
    "version": 3
  }
}

Copy Rows

Copies rows to another sheet. | key: copyRows

Input	Notes	Example
Connection	The Smartsheet connection to use.
Row IDs	The IDs of the rows to move or copy from the source sheet	6830028284938
Source Sheet ID	The unique identifier of the sheet to copy or move rows from.
Destination Sheet ID	The unique identifier of the sheet to move or copy rows into.

{
  "data": {
    "destinationSheetId": 6166656104851332,
    "rowMappings": [
      {
        "from": 1490138716891012,
        "to": 8616643133106052
      },
      {
        "from": 5993738344261508,
        "to": 453868808497028
      }
    ]
  }
}

Copy Sheet

Copies a sheet to a specified destination. | key: copySheet

Input	Notes	Example
Connection	The Smartsheet connection to use.
Destination ID	The ID of the destination container (when copying or moving a sheet or a folder).
Destination Type	The type of container to copy or move the resource into.	home
New Name	The display name to assign to the copied resource.
Sheet ID	The unique identifier for the sheet.	4583173393803140

{
  "data": {
    "message": "SUCCESS",
    "resultCode": 0,
    "result": {
      "id": 4366633289443204,
      "name": "New Sheet Name",
      "accessLevel": "OWNER",
      "permalink": "https://app.smartsheet.com/b/home?lx=lB0JaOh6AX1wGwqxsQIMaA"
    }
  }
}

Create Discussion

Creates a discussion on a sheet or row. | key: discussionsCreate

Input	Notes	Example
Comment	The text content to post as a new discussion comment.
Connection	The Smartsheet connection to use.
Row ID (Optional)	The unique identifier for the row. Leave empty to apply to the sheet level.	8908091207493508
Sheet ID	The unique identifier for the sheet.	4583173393803140

{
  "data": {
    "message": "SUCCESS",
    "resultCode": 0,
    "result": {
      "id": 4345865909364612,
      "title": "My Comment",
      "comments": [
        {
          "id": 8565339061544836,
          "text": "My Comment",
          "createdBy": {
            "email": "example@example.com"
          },
          "createdAt": "2022-06-30T22:08:09Z",
          "modifiedAt": "2022-06-30T22:08:09Z"
        }
      ],
      "commentCount": 1,
      "lastCommentedAt": "2022-06-30T22:08:09Z",
      "lastCommentedUser": {
        "email": "example@example.com"
      },
      "createdBy": {
        "email": "example@example.com"
      }
    },
    "version": 24
  }
}

Create Folder

Creates a new folder in a specified location. | key: createFolder

Input	Notes	Example
Connection	The Smartsheet connection to use.
Folder ID	Enter the ID of a folder to create a subfolder in, or omit this value to create a top-level home folder.	375893453
Folder Name	The display name for the folder.	My Folder
Workspace ID (Optional)	Create in this workspace. Optional.	843750385

{
  "data": {
    "message": "SUCCESS",
    "resultCode": 0,
    "result": {
      "id": 3989276003198852,
      "name": "My New Folder",
      "permalink": "https://app.smartsheet.com/folders/jrWJMrFqfFf82WjGfX4rHW755FCrWfvJ4Mc3G5f1"
    }
  }
}

Create Sheet

Creates a new sheet with specified columns. | key: createSheet

Input	Notes	Example
Columns	See Smartsheet API documentation for additional information about column types.
Connection	The Smartsheet connection to use.
Folder ID	Create sheet in this folder. Omit to create a top-level sheet.	375893453
Sheet Name	The display name for the new sheet.
Workspace ID (Optional)	The unique identifier for the workspace. Leave empty to use the default context.	843750385

{
  "data": {
    "message": "SUCCESS",
    "resultCode": 0,
    "result": {
      "id": 4153158256617348,
      "name": "My Sheet",
      "accessLevel": "OWNER",
      "permalink": "https://app.smartsheet.com/sheets/wC88GhRM32m4jwvjcgvGrW82Qcm4Q7Rpp3XQQGc1",
      "columns": [
        {
          "id": 7935520919578500,
          "version": 0,
          "index": 0,
          "title": "Favorite",
          "type": "CHECKBOX",
          "symbol": "STAR",
          "validation": false,
          "width": 150
        },
        {
          "id": 617171525101444,
          "version": 0,
          "index": 1,
          "title": "Primary Column",
          "type": "TEXT_NUMBER",
          "primary": true,
          "validation": false,
          "width": 150
        }
      ]
    }
  }
}

Create Webhook

Creates and enables a webhook for a specified resource. | key: createWebhook

Input	Notes	Example
Allow Duplicates?	By default this action checks if a webhook with this callback and sheet ID already exists. If it does, this action does not configure a new webhook. Toggle this to true to allow the creation of duplicate webhooks.	false
Callback URL	The URL that Smartsheet sends webhook notifications to. This is usually a reference to another flow's webhook URL.
Connection	The Smartsheet connection to use.
Webhook Name	A descriptive label to identify the webhook in the dashboard.
Sheet ID	The unique identifier for the sheet.	4583173393803140

By default this action checks if a webhook is already configured for the given sheet and callback URL, and does not create duplicate webhooks if one already exists. That behavior can be overridden through the Allow Duplicates? input.

{
  "data": {
    "message": "UNCHANGED",
    "resultCode": 0,
    "result": {
      "id": 8951687911106436,
      "name": "Example Webhook",
      "apiClientId": "ixubfhznhzs4qmmurvm",
      "apiClientName": "Example Test App",
      "scope": "sheet",
      "scopeObjectId": 285065612683140,
      "subscope": {
        "columnIds": []
      },
      "events": [
        "*.*"
      ],
      "callbackUrl": "https://hooks.example.com/trigger/EXAMPLE",
      "sharedSecret": "289c4s9hnfp4b368x4p4wu9gea",
      "enabled": true,
      "status": "ENABLED",
      "version": 1,
      "createdAt": "2022-06-27T21:34:21Z",
      "modifiedAt": "2022-06-27T21:34:24Z"
    }
  }
}

Create Workspace

Creates a new workspace. | key: createWorkspace

Input	Notes	Example
Connection	The Smartsheet connection to use.
Workspace Name	The display name for the workspace.	New Workspace

{
  "data": {
    "message": "SUCCESS",
    "resultCode": 0,
    "result": {
      "accessLevel": "OWNER",
      "id": 7960873114331012,
      "name": "New workspace",
      "permalink": "https://app.smartsheet.com/b/home?lx=rBU8QqUVPCJ3geRgl7L8yQ"
    }
  }
}

Delete Column

Deletes a column from a sheet. | key: columnDelete

Input	Notes	Example
Column ID	The unique identifier for the column.	7960873114331012
Connection	The Smartsheet connection to use.
Sheet ID	The unique identifier for the sheet.	4583173393803140

{
  "data": {
    "message": "SUCCESS",
    "resultCode": 0
  }
}

Delete Comment

Deletes a comment by its ID. | key: commentDelete

Input	Notes	Example
Comment ID	The unique identifier for the comment.	3888061631401860
Connection	The Smartsheet connection to use.
Sheet ID	The unique identifier for the sheet.	4583173393803140

{
  "data": {
    "message": "SUCCESS",
    "resultCode": 0,
    "version": 12
  }
}

Delete Discussion

Deletes a discussion from a sheet or row. | key: discussionDelete

Input	Notes	Example
Connection	The Smartsheet connection to use.
Discussion ID	The unique identifier for the discussion.	3650061106619268
Sheet ID	The unique identifier for the sheet.	4583173393803140

{
  "data": {
    "message": "SUCCESS",
    "resultCode": 0
  }
}

Delete Folder

Deletes a folder by its ID. | key: deleteFolder

Input	Notes	Example
Connection	The Smartsheet connection to use.
Folder ID	The unique identifier for the folder. Folders can contain sheets, sights, reports, templates, and other folders.	375893453

{
  "data": {
    "message": "SUCCESS",
    "resultCode": 0
  }
}

Delete Instance Webhooks

Deletes all Smartsheet webhooks that point to a flow in this instance. | key: deleteInstanceWebhooks

Input	Notes	Example
Connection	The Smartsheet connection to use.

{
  "data": null
}

Delete Row

Deletes a row from a sheet. | key: deleteRow

Input	Notes	Example
Connection	The Smartsheet connection to use.
Row ID	The unique identifier for the row.	8908091207493508
Sheet ID	The unique identifier for the sheet.	4583173393803140

{
  "data": {
    "message": "SUCCESS",
    "resultCode": 0,
    "result": [
      207098194749316
    ]
  }
}

Delete Sheet

Deletes a sheet by its ID. | key: deleteSheet

Input	Notes	Example
Connection	The Smartsheet connection to use.
Sheet ID	The unique identifier for the sheet.	4583173393803140

{
  "data": {
    "message": "SUCCESS",
    "resultCode": 0
  }
}

Delete Webhook

Deletes a webhook by its ID. | key: deleteWebhook

Input	Notes	Example
Connection	The Smartsheet connection to use.
Webhook ID	The unique identifier for the webhook.	8444254503626628

{
  "data": {
    "message": "SUCCESS",
    "resultCode": 0
  }
}

Delete Workspace

Deletes a workspace by its ID. | key: deleteWorkspace

Input	Notes	Example
Connection	The Smartsheet connection to use.
Workspace ID	The unique identifier for the workspace.	843750385

{
  "data": {
    "message": "SUCCESS",
    "resultCode": 0
  }
}

Edit Comment

Edits a comment by its ID. | key: commentEdit

Input	Notes	Example
Comment ID	The unique identifier for the comment.	3888061631401860
Connection	The Smartsheet connection to use.
Sheet ID	The unique identifier for the sheet.	4583173393803140
Text	The text content of the comment.

{
  "data": {
    "message": "SUCCESS",
    "resultCode": 0,
    "result": {
      "id": 7144101943502724,
      "discussionId": 4503677744506756,
      "text": "This is the updated comment text.",
      "createdBy": {
        "name": "John Doe",
        "email": "john.doe@smartsheet.com"
      },
      "createdAt": "2013-01-10T13:43:26Z",
      "modifiedAt": "2013-01-12T19:00:26Z"
    },
    "version": 18
  }
}

Get Column

Retrieves a column by its ID. | key: columnGet

Input	Notes	Example
Column ID	The unique identifier for the column.	7960873114331012
Connection	The Smartsheet connection to use.
Sheet ID	The unique identifier for the sheet.	4583173393803140

{
  "data": {
    "id": 7960873114331012,
    "index": 2,
    "symbol": "STAR",
    "title": "Favorite",
    "type": "CHECKBOX",
    "validation": false
  }
}

Get Comment

Retrieves a comment by its ID. | key: commentGet

Input	Notes	Example
Comment ID	The unique identifier for the comment.	3888061631401860
Connection	The Smartsheet connection to use.
Sheet ID	The unique identifier for the sheet.	4583173393803140

{
  "data": {
    "text": "This is a comment",
    "createdBy": {
      "name": "John Doe",
      "email": "john.doe@smartsheet.com"
    },
    "createdAt": "2013-06-24T21:07:45Z",
    "modifiedAt": "2013-06-24T21:07:45Z",
    "discussionId": 4503677744506756,
    "id": 48569348493401200
  }
}

Get Contact

Retrieves a contact by its ID. | key: getContact

Input	Notes	Example
Connection	The Smartsheet connection to use.
Contact ID	The unique identifier for the contact.

{
  "data": {
    "id": "AAeDyHYU54QAB4PIdhTnhA",
    "name": "John Doe",
    "email": "john.doe@example.com"
  }
}

Get Discussion

Retrieves a discussion by its ID. | key: discussionGet

Input	Notes	Example
Connection	The Smartsheet connection to use.
Discussion ID	The unique identifier for the discussion.	3650061106619268
Sheet ID	The unique identifier for the sheet.	4583173393803140

{
  "data": {
    "id": 1587586573592452,
    "title": "My Comment",
    "comments": [
      {
        "id": 4718943518648196,
        "text": "My Comment",
        "createdBy": {
          "email": "example@example.com"
        },
        "createdAt": "2022-06-30T22:06:15Z",
        "modifiedAt": "2022-06-30T22:06:15Z"
      }
    ],
    "commentCount": 1,
    "accessLevel": "OWNER",
    "parentType": "ROW",
    "parentId": 7119638251104132,
    "lastCommentedAt": "2022-06-30T22:06:15Z",
    "lastCommentedUser": {
      "email": "example@example.com"
    },
    "createdBy": {
      "email": "example@example.com"
    }
  }
}

Get Folder

Retrieves a folder by its ID. | key: getFolder

Input	Notes	Example
Connection	The Smartsheet connection to use.
Folder ID	The unique identifier for the folder. Folders can contain sheets, sights, reports, templates, and other folders.	375893453

{
  "data": {
    "id": 4739830128109444,
    "name": "My Folder",
    "permalink": "https://app.smartsheet.com/folders/V9rx6x5JXXxR28GHfw9vCW8RcWR44HHJrjWPfHr1",
    "sheets": [
      {
        "id": 5577163253540740,
        "name": "My Test Sheet",
        "accessLevel": "OWNER",
        "permalink": "https://app.smartsheet.com/sheets/ppG8788PjXmQFh4PjpvfMrRfQFvjC3cG6fM4G231",
        "source": {
          "id": 4503604829677444,
          "type": "sheet"
        },
        "createdAt": "2022-06-27T15:03:02Z",
        "modifiedAt": "2022-06-27T15:03:02Z",
        "owner": "example@example.com",
        "ownerId": 789168465962884,
        "version": 0
      },
      {
        "id": 6913677619160964,
        "name": "My Task List",
        "accessLevel": "OWNER",
        "permalink": "https://app.smartsheet.com/sheets/P88MWxqggQxpCH3cJq3PfwXj98Wcg2pxGfcPMH51",
        "source": {
          "id": 2251805015992196,
          "type": "sheet"
        },
        "createdAt": "2022-06-27T15:03:07Z",
        "modifiedAt": "2022-06-27T15:03:07Z",
        "owner": "example@example.com",
        "ownerId": 789168465962884,
        "version": 0
      }
    ]
  }
}

Get Group

Retrieves a group by its ID. | key: getGroup

Input	Notes	Example
Connection	The Smartsheet connection to use.
Group ID	The unique identifier for the group.	375893453

{
  "data": {
    "id": 2295323772118916,
    "name": "Example Group",
    "owner": "example@example.com",
    "ownerId": 789168465962884,
    "members": [
      {
        "id": 789168465962884,
        "email": "example@example.com"
      }
    ],
    "createdAt": "2022-06-27T18:31:44Z",
    "modifiedAt": "2022-06-27T18:31:44Z"
  }
}

Get Report

Retrieves a report including one page of rows, attachments, discussions, and source sheets. | key: getReport

Input	Notes	Example
Connection	The Smartsheet connection to use.
Pagination Page	The 1-based page number to return.	1
Pagination Page Size	The maximum number of items to return per page.
Report ID	The unique identifier for the report.	2973569197942660

Get Row

Retrieves the contents of a row by its ID. | key: rowGet

Input	Notes	Example
Connection	The Smartsheet connection to use.
Row ID	The unique identifier for the row.	8908091207493508
Sheet ID	The unique identifier for the sheet.	4583173393803140

{
  "data": {
    "id": 1490138716891012,
    "sheetId": 285065612683140,
    "rowNumber": 2,
    "parentId": 7119638251104132,
    "version": 49,
    "permalink": "https://app.smartsheet.com/sheets/jVm6gg56FHw65FFPGfQrHjhMCJ9R42jqMxMvHvP1?rowId=1490138716891012",
    "filteredOut": false,
    "expanded": true,
    "accessLevel": "OWNER",
    "createdAt": "2022-06-23T20:05:05Z",
    "createdBy": {
      "email": "example@company.com"
    },
    "modifiedAt": "2022-06-23T20:05:07Z",
    "modifiedBy": {
      "email": "example@company.com"
    },
    "cells": [
      {
        "columnId": 4275832638203780,
        "columnType": "TEXT_NUMBER",
        "value": "My Subtask 1",
        "objectValue": "My Subtask 1",
        "displayValue": "My Subtask 1",
        "format": ",,,,,,,,,,,,,,,1,"
      },
      {
        "columnId": 8779432265574276,
        "columnType": "CONTACT_LIST",
        "value": "example@company.com",
        "objectValue": {
          "objectType": "CONTACT",
          "email": "example@company.com",
          "name": "example@company.com"
        },
        "displayValue": "example@company.com"
      },
      {
        "columnId": 194445475899268,
        "columnType": "DATE",
        "value": "2022-06-23",
        "objectValue": {
          "objectType": "DATE",
          "value": "2022-06-23"
        }
      }
    ]
  }
}

Get Sheet

Retrieves a sheet by its ID. | key: getSheet

Input	Notes	Example
Connection	The Smartsheet connection to use.
Pagination Page	The 1-based page number to return.	1
Pagination Page Size	The maximum number of items to return per page.
Sheet ID	The unique identifier for the sheet.	4583173393803140

{
  "data": {
    "id": 4583173393803140,
    "name": "sheet 1",
    "version": 6,
    "totalRowCount": 240,
    "accessLevel": "OWNER",
    "effectiveAttachmentOptions": [
      "EVERNOTE",
      "GOOGLE_DRIVE",
      "EGNYTE",
      "FILE",
      "ONEDRIVE",
      "DROPBOX",
      "BOX_COM"
    ],
    "readOnly": true,
    "ganttEnabled": true,
    "dependenciesEnabled": true,
    "resourceManagementEnabled": true,
    "cellImageUploadEnabled": true,
    "userSettings": {
      "criticalPathEnabled": false,
      "displaySummaryTasks": true
    },
    "userPermissions": {
      "summaryPermissions": "ADMIN"
    },
    "workspace": {
      "id": 825898975642500,
      "name": "New Workspace"
    },
    "projectSettings": {
      "workingDays": [
        "MONDAY",
        "TUESDAY",
        "WEDNESDAY"
      ],
      "nonWorkingDays": [],
      "lengthOfDay": 8
    },
    "hasSummaryFields": false,
    "permalink": "https://app.smartsheet.com/b/home?lx=pWNSDH9itjBXxBzFmyf-5w",
    "createdAt": "2018-09-24T20:27:57Z",
    "modifiedAt": "2018-09-26T20:45:08Z",
    "columns": [
      {
        "id": 4583173393803140,
        "version": 1,
        "index": 0,
        "primary": true,
        "title": "Primary Column",
        "type": "TEXT_NUMBER",
        "validation": false
      },
      {
        "id": 603843458295684,
        "version": 2,
        "index": 5,
        "title": "New Dropdown Multi Select",
        "type": "MULTI_PICKLIST",
        "options": [
          "Template",
          "Blog",
          "Newsletter",
          "Email",
          "Press Release",
          "Advertisement"
        ],
        "validation": false,
        "width": 150
      }
    ],
    "rows": []
  }
}

Get Sheet Attachment

Retrieves metadata for an attachment on a sheet. | key: attachmentsGet

Input	Notes	Example
Attachment ID	The unique identifier for the attachment.	1018169196216196
Connection	The Smartsheet connection to use.
Sheet ID	The unique identifier for the sheet.	4583173393803140

{
  "data": {
    "name": "expense_report_sample.png",
    "url": "https://api.smartsheet.com/download/aa402974cdb74cb58d9",
    "attachmentType": "FILE",
    "mimeType": "image/png",
    "id": 4583173393803140,
    "urlExpiresInMillis": 120000
  }
}

Get Sheet Publish Status

Retrieves the publish status of a sheet. | key: getSheetPublish

Input	Notes	Example
Connection	The Smartsheet connection to use.
Sheet ID	The unique identifier for the sheet.	4583173393803140

{
  "data": {
    "readOnlyLiteEnabled": false,
    "readOnlyFullEnabled": true,
    "readWriteEnabled": false,
    "icalEnabled": false,
    "readOnlyFullAccessibleBy": "ALL",
    "readOnlyFullUrl": "https://publish.smartsheet.com/6d35fa6c99334d4892f9591cf6065"
  }
}

Get Sheet Version

Retrieves the version number of a sheet. | key: getSheetVersion

Input	Notes	Example
Connection	The Smartsheet connection to use.
Sheet ID	The unique identifier for the sheet.	4583173393803140

{
  "data": {
    "version": 4
  }
}

Get User

Retrieves a user by their ID. | key: getUser

Input	Notes	Example
Connection	The Smartsheet connection to use.
User ID	The ID of a user to fetch. Enter 'me' to get currently logged in user

{
  "data": {
    "id": 48569348493401200,
    "email": "john.doe@smartsheet.com",
    "firstName": "John",
    "lastName": "Doe",
    "locale": "en_US",
    "timeZone": "US/Pacific",
    "account": {
      "name": "Team Smartsheet",
      "id": 942513719853956
    },
    "admin": true,
    "licensedSheetCreator": true,
    "groupAdmin": true,
    "resourceViewer": true,
    "jiraAdmin": false,
    "salesforceAdmin": false,
    "salesforceUser": false,
    "alternateEmails": [
      {
        "id": 8026717110462340,
        "email": "altEmail1@smartsheet.com",
        "confirmed": true
      }
    ],
    "title": "Senior Sales Representative",
    "department": "Marketing",
    "company": "Smartsheet",
    "workPhone": "",
    "mobilePhone": "206 123-4567",
    "role": "Sales",
    "profileImage": {
      "imageId": "u!1!8ljad7w9-aY!AsDeH0wWv1Y!y9VvAgUOFdg",
      "height": 1050,
      "width": 1050
    },
    "sheetCount": 3,
    "lastLogin": "2016-08-15T18:32:47Z",
    "customWelcomeScreenViewed": "2016-08-12T12:15:47Z",
    "groups": [
      {
        "id": 2295323772118916,
        "name": "Team dev",
        "description": "Development team group"
      }
    ]
  }
}

Get Webhook

Retrieves a webhook by its ID. | key: getWebhook

Input	Notes	Example
Connection	The Smartsheet connection to use.
Webhook ID	The unique identifier for the webhook.	8444254503626628

{
  "data": {
    "id": 8951687911106436,
    "name": "Example Webhook",
    "apiClientId": "ixubfhznhzs4qmmurvm",
    "apiClientName": "Example Test App",
    "scope": "sheet",
    "scopeObjectId": 285065612683140,
    "subscope": {
      "columnIds": []
    },
    "events": [
      "*.*"
    ],
    "callbackUrl": "https://hooks.example.com/trigger/EXAMPLE",
    "sharedSecret": "289c4s9hnfp4b368x4p4wu9gea",
    "enabled": true,
    "status": "ENABLED",
    "version": 1,
    "createdAt": "2022-06-27T21:34:21Z",
    "modifiedAt": "2022-06-27T21:34:24Z"
  }
}

Get Workspace

Retrieves a workspace by its ID. | key: getWorkspace

Input	Notes	Example
Connection	The Smartsheet connection to use.
Load All	When true, includes nested folders and their contents in the response.	false
Workspace ID	The unique identifier for the workspace.	843750385

{
  "data": {
    "sheets": [
      {
        "id": 4583173393803140,
        "name": "sheet 1",
        "accessLevel": "OWNER",
        "permalink": "https://app.smartsheet.com/b/home?lx=8Z0XuFUEAkxmHCSsMw4Zg1",
        "createdAt": "2015-06-05T20:05:29Z",
        "modifiedAt": "2015-06-05T20:05:43Z"
      }
    ],
    "accessLevel": "OWNER",
    "id": 7116448184199044,
    "name": "New workspace",
    "permalink": "https://app.smartsheet.com/b/home?lx=8Z0XuFUEAkxmHCSsMw4Zgg"
  }
}

List Attachments on Row

Lists attachments on a row of a sheet. | key: attachmentsListOnRow

Input	Notes	Example
Connection	The Smartsheet connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the specified page is returned.	false
Pagination Page	The 1-based page number to return.	1
Pagination Page Size	The maximum number of items to return per page.
Row ID	The unique identifier for the row.	8908091207493508
Sheet ID	The unique identifier for the sheet.	4583173393803140

{
  "data": {
    "pageNumber": 1,
    "pageSize": 100,
    "totalPages": 1,
    "totalCount": 2,
    "data": [
      {
        "name": "att3.png",
        "attachmentType": "FILE",
        "mimeType": "image/png",
        "id": 4583173393803140,
        "parentType": "ROW",
        "parentId": 341847495283
      },
      {
        "name": "att4.png",
        "attachmentType": "FILE",
        "mimeType": "image/png",
        "id": 7993173393803140,
        "parentType": "COMMENT",
        "parentId": 684956754834557
      }
    ]
  }
}

List Attachments on Sheet

Lists all attachments on a sheet. | key: attachmentsListOnSheet

Input	Notes	Example
Connection	The Smartsheet connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the specified page is returned.	false
Pagination Page	The 1-based page number to return.	1
Pagination Page Size	The maximum number of items to return per page.
Sheet ID	The unique identifier for the sheet.	4583173393803140

{
  "data": {
    "pageNumber": 1,
    "pageSize": 100,
    "totalPages": 1,
    "totalCount": 2,
    "data": [
      {
        "name": "att3.png",
        "attachmentType": "FILE",
        "mimeType": "image/png",
        "id": 4583173393803140,
        "parentType": "SHEET",
        "parentId": 341847495283
      },
      {
        "name": "att4.png",
        "attachmentType": "FILE",
        "mimeType": "image/png",
        "id": 7993173393803140,
        "parentType": "ROW",
        "parentId": 684956754834557
      }
    ]
  }
}

List Columns

Lists all columns on a sheet. | key: columnsListOnSheet

Input	Notes	Example
Connection	The Smartsheet connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the specified page is returned.	false
Pagination Page	The 1-based page number to return.	1
Pagination Page Size	The maximum number of items to return per page.
Sheet ID	The unique identifier for the sheet.	4583173393803140

{
  "data": {
    "pageNumber": 1,
    "pageSize": 100,
    "totalPages": 1,
    "totalCount": 3,
    "data": [
      {
        "id": 7960873114331012,
        "index": 0,
        "symbol": "STAR",
        "title": "Favorite",
        "type": "CHECKBOX",
        "validation": false
      },
      {
        "id": 642523719853956,
        "index": 1,
        "primary": true,
        "title": "Primary Column",
        "type": "TEXT_NUMBER",
        "validation": false
      },
      {
        "id": 5146123347224452,
        "index": 2,
        "title": "Status",
        "type": "PICKLIST",
        "validation": false
      }
    ]
  }
}

List Contacts

Lists all contacts for the authenticated user. | key: listContacts

Input	Notes	Example
Connection	The Smartsheet connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the specified page is returned.	false
Pagination Page	The 1-based page number to return.	1
Pagination Page Size	The maximum number of items to return per page.

{
  "data": {
    "pageNumber": 1,
    "totalPages": 1,
    "totalCount": 1,
    "data": [
      {
        "id": "AAeDyHYU54QAB4PIdhTnhA",
        "name": "John Doe",
        "email": "john.doe@example.com"
      }
    ]
  }
}

List Discussion Attachments

Lists all attachments on a discussion. | key: discussionListAttachments

Input	Notes	Example
Connection	The Smartsheet connection to use.
Discussion ID	The unique identifier for the discussion.	3650061106619268
Fetch All	When true, automatically fetches all pages of results. When false, only the specified page is returned.	false
Pagination Page	The 1-based page number to return.	1
Pagination Page Size	The maximum number of items to return per page.
Sheet ID	The unique identifier for the sheet.	4583173393803140

{
  "data": {
    "pageNumber": 1,
    "pageSize": 100,
    "totalPages": 1,
    "totalCount": 2,
    "data": [
      {
        "name": "att3.png",
        "attachmentType": "FILE",
        "mimeType": "image/png",
        "id": 4583173393803140,
        "parentType": "COMMENT",
        "parentId": 341847495283
      },
      {
        "name": "att4.png",
        "attachmentType": "FILE",
        "mimeType": "image/png",
        "id": 7993173393803140,
        "parentType": "COMMENT",
        "parentId": 684956754834557
      }
    ]
  }
}

List Discussions

Lists discussions on a sheet or row. | key: discussionsList

Input	Notes	Example
Connection	The Smartsheet connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the specified page is returned.	false
Pagination Page	The 1-based page number to return.	1
Pagination Page Size	The maximum number of items to return per page.
Row ID (Optional)	The unique identifier for the row. Leave empty to apply to the sheet level.	8908091207493508
Sheet ID	The unique identifier for the sheet.	4583173393803140

{
  "data": {
    "pageNumber": 1,
    "pageSize": 100,
    "totalPages": 1,
    "totalCount": 1,
    "data": [
      {
        "id": 3138415114905476,
        "title": "Lincoln",
        "comments": [
          {
            "id": 7320407591151492,
            "text": "16th President",
            "createdBy": {
              "name": "Test User",
              "email": "tester@smartsheet.com"
            },
            "createdAt": "2015-01-12T18:23:02-08:00",
            "modifiedAt": "2015-01-12T18:23:02-08:00"
          }
        ],
        "commentCount": 1,
        "accessLevel": "OWNER",
        "parentType": "ROW",
        "parentId": 4508369022150532,
        "lastCommentedUser": {
          "name": "Test User",
          "email": "tester@smartsheet.com"
        },
        "createdBy": {
          "name": "Test User",
          "email": "tester@smartsheet.com"
        },
        "readOnly": false,
        "lastCommentedAt": "2015-01-12T18:23:02-08:00"
      }
    ]
  }
}

List Events

Lists events occurring in the Smartsheet organization account. | key: listEvents

Input	Notes	Example
Connection	The Smartsheet connection to use.
Max Count	The maximum number of events to return as response to this call.
Since	The starting timestamp for events to return. Format: ISO 8601 (e.g. 2010-01-01T00:00:00Z).	2010-01-01T00:00:00Z
Stream Position	Indicates next set of events to return	XyzAb1234cdefghijklmnofpq

{
  "data": {
    "nextStreamPosition": "XyzAb1234cdefghijklmnofpq",
    "moreAvailable": "false",
    "data": [
      {
        "eventId": "4b12345abc444def333g149he2b15b3j",
        "objectType": "SHEET",
        "action": "LOAD",
        "objectId": "345678901234",
        "eventTimestamp": "2019-04-29T08:28:33Z",
        "userId": "123457654321",
        "requestUserId": "133445566778",
        "source": "WEB_APP",
        "additionalDetails": {}
      }
    ]
  }
}

List Favorites

Lists all favorite items for the authenticated user. | key: getFavorites

Input	Notes	Example
Connection	The Smartsheet connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the specified page is returned.	false
Pagination Page	The 1-based page number to return.	1
Pagination Page Size	The maximum number of items to return per page.

{
  "data": {
    "pageNumber": 1,
    "pageSize": 100,
    "totalPages": 1,
    "totalCount": 2,
    "data": [
      {
        "type": "sheet",
        "objectId": 5897312590423940
      },
      {
        "type": "folder",
        "objectId": 1493728255862660
      }
    ]
  }
}

List Folders

Lists folders, subfolders, or workspace folders. | key: listFolders

Input	Notes	Example
Connection	The Smartsheet connection to use.
Folder ID	Enter the ID of a folder to list subfolders, or omit this value to list top-level home folders.	375893453
Fetch All	When true, automatically fetches all pages of results. When false, only the specified page is returned.	false
Pagination Page	The 1-based page number to return.	1
Pagination Page Size	The maximum number of items to return per page.
Workspace ID (Optional)	Create in this workspace. Optional.	843750385

{
  "data": {
    "pageNumber": 1,
    "totalPages": 1,
    "totalCount": 3,
    "data": [
      {
        "id": 4739830128109444,
        "name": "Folder 1",
        "permalink": "https://app.smartsheet.com/folders/V9rx6x5JXXxR28GHfw9vCW8RcWR44HHJrjWPfHr1"
      },
      {
        "id": 7836054871926660,
        "name": "Folder 2",
        "permalink": "https://app.smartsheet.com/folders/CQmHFFGXWC67CqxjFJJQv9q4GXqpRx2m9gHg7Rx1"
      }
    ]
  }
}

List Groups

Lists all groups in the organization. | key: listGroups

Input	Notes	Example
Connection	The Smartsheet connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the specified page is returned.	false
Modified Since	When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified. Format: ISO 8601 (e.g. 2023-01-01T00:00:00Z).
Pagination Page	The 1-based page number to return.	1
Pagination Page Size	The maximum number of items to return per page.

{
  "data": {
    "pageNumber": 1,
    "pageSize": 100,
    "totalPages": 1,
    "totalCount": 1,
    "data": [
      {
        "id": 4583173393803140,
        "name": "Group 1",
        "description": "My group",
        "owner": "john.doe@smartsheet.com",
        "ownerId": 2331373580117892,
        "createdAt": "2014-05-29T14:41:35-07:00",
        "modifiedAt": "2014-05-29T14:41:35-07:00"
      }
    ]
  }
}

List Home Contents

Lists all Home objects, including dashboards, folders, reports, sheets, templates, and workspaces. | key: listHomeContents

Input	Notes	Example
Connection	The Smartsheet connection to use.

{
  "data": {
    "sheets": [
      {
        "id": 1514484968777604,
        "name": "My Sheet",
        "accessLevel": "OWNER",
        "permalink": "https://app.smartsheet.com/sheets/28wxmmfHhc7c92JRgx8qwp3MjJ338XXgWVP5QqR1",
        "createdAt": "2022-06-27T17:18:56Z",
        "modifiedAt": "2022-06-27T17:18:56Z"
      }
    ],
    "folders": [
      {
        "id": 1115290047145860,
        "name": "My Folder",
        "permalink": "https://app.smartsheet.com/folders/VRmCXx7VvJXchgPMxcR88Vq5RVH5QPW2JwVpXjF1",
        "sheets": [
          {
            "id": 6166656104851332,
            "name": "My Sheet",
            "accessLevel": "OWNER",
            "permalink": "https://app.smartsheet.com/sheets/pqFGc5cVvVw6hpfQ32Pw2hMFcPpVWWMhQ686QVW1",
            "createdAt": "2022-06-27T17:26:20Z",
            "modifiedAt": "2022-06-27T17:26:20Z"
          }
        ],
        "folders": [
          {
            "id": 4739830128109444,
            "name": "Subfolder 1",
            "permalink": "https://app.smartsheet.com/folders/V9rx6x5JXXxR28GHfw9vCW8RcWR44HHJrjWPfHr1",
            "sheets": [
              {
                "id": 6913677619160964,
                "name": "My Task List",
                "accessLevel": "OWNER",
                "permalink": "https://app.smartsheet.com/sheets/P88MWxqggQxpCH3cJq3PfwXj98Wcg2pxGfcPMH51",
                "createdAt": "2022-06-27T15:03:07Z",
                "modifiedAt": "2022-06-27T15:03:07Z"
              },
              {
                "id": 5577163253540740,
                "name": "My Test Sheet",
                "accessLevel": "OWNER",
                "permalink": "https://app.smartsheet.com/sheets/ppG8788PjXmQFh4PjpvfMrRfQFvjC3cG6fM4G231",
                "createdAt": "2022-06-27T15:03:02Z",
                "modifiedAt": "2022-06-27T15:03:02Z"
              }
            ]
          }
        ]
      }
    ],
    "workspaces": [
      {
        "id": 3776173869164420,
        "name": "My Test",
        "accessLevel": "OWNER",
        "permalink": "https://app.smartsheet.com/workspaces/M5hwX6XMQxfvRr9xHh77XgRWGhW8VWMXrX54mhw1",
        "sheets": [
          {
            "id": 285065612683140,
            "name": "1. Task Sheet",
            "accessLevel": "OWNER",
            "favorite": true,
            "permalink": "https://app.smartsheet.com/sheets/jVm6gg56FHw65FFPGfQrHjhMCJ9R42jqMxMvHvP1",
            "createdAt": "2022-06-23T20:05:05Z",
            "modifiedAt": "2022-06-24T16:55:36Z"
          }
        ],
        "folders": [
          {
            "id": 5659485705398148,
            "name": "Workspace Folder 1",
            "permalink": "https://app.smartsheet.com/folders/5GgFJ2Rr38FjjxVP7gfR39WpC6CMPgrHM3m7rF41"
          }
        ],
        "reports": [
          {
            "id": 2536865426368388,
            "name": "2. Task Summary Report",
            "accessLevel": "OWNER",
            "permalink": "https://app.smartsheet.com/reports/3qmCpFWQ3MVqwF5hCHmxjVrPw8cW9CQR8H2pcVr1",
            "createdAt": "2022-06-23T20:05:06Z",
            "modifiedAt": "2022-06-23T20:05:07Z"
          }
        ],
        "sights": [
          {
            "id": 2689058288756612,
            "name": "4. Project Dashboard",
            "accessLevel": "OWNER",
            "permalink": "https://app.smartsheet.com/dashboards/jH9Q2r3P3gjPmQgX93CvvCFjHVgGq6W894Mx67W1",
            "createdAt": "2022-06-23T20:05:06Z",
            "modifiedAt": "2022-06-23T20:05:07Z"
          }
        ]
      },
      {
        "id": 7240855267370884,
        "name": "Team dev",
        "accessLevel": "OWNER",
        "permalink": "https://app.smartsheet.com/workspaces/69g47w4FxcFXMRfFprpwqw26qH4cvw287WW7F9R1",
        "sheets": [
          {
            "id": 923909785708420,
            "name": "Project Launch Plan",
            "accessLevel": "OWNER",
            "permalink": "https://app.smartsheet.com/sheets/5MXR3wMRhpmVjgPqGj2JFWfw398RhPVXfqg7Vrf1",
            "createdAt": "2022-06-27T18:31:29Z",
            "modifiedAt": "2022-06-27T18:31:29Z"
          }
        ]
      }
    ]
  }
}

List Public Templates

Lists publicly available templates. | key: templatesListPublic

Input	Notes	Example
Connection	The Smartsheet connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the specified page is returned.	false
Pagination Page	The 1-based page number to return.	1
Pagination Page Size	The maximum number of items to return per page.

{
  "data": {
    "pageNumber": 1,
    "pageSize": 100,
    "totalPages": 1,
    "totalCount": 2,
    "data": [
      {
        "id": 5993738344261508,
        "name": "Basic Project with Gantt & Dependencies",
        "type": "sheet",
        "accessLevel": "VIEWER",
        "description": "Manage a simple project with tasks, durations, and dependencies using a Gantt chart",
        "globalTemplate": "PROJECT_SHEET"
      },
      {
        "id": 3741938530576260,
        "name": "Task List",
        "type": "sheet",
        "accessLevel": "VIEWER",
        "description": "Track to-do items with status, priority, and due date columns",
        "globalTemplate": "TASK_LIST"
      }
    ]
  }
}

List Reports

Lists all reports accessible to the authenticated user. | key: getReports

Input	Notes	Example
Connection	The Smartsheet connection to use.
Modified Since	When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified. Format: ISO 8601 (e.g. 2023-01-01T00:00:00Z).

{
  "data": {
    "pageNumber": 1,
    "pageSize": 100,
    "totalPages": 1,
    "totalCount": 3,
    "data": [
      {
        "id": 2536865426368388,
        "name": "2. Task Summary Report",
        "accessLevel": "OWNER",
        "permalink": "https://app.smartsheet.com/reports/3qmCpFWQ3MVqwF5hCHmxjVrPw8cW9CQR8H2pcVr1",
        "isSummaryReport": false
      }
    ]
  }
}

List Sheets

Lists all sheets accessible to the authenticated user. | key: listSheets

Input	Notes	Example
Connection	The Smartsheet connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the specified page is returned.	false
Modified Since	When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified. Format: ISO 8601 (e.g. 2023-01-01T00:00:00Z).
Pagination Page	The 1-based page number to return.	1
Pagination Page Size	The maximum number of items to return per page.

{
  "data": {
    "pageNumber": 1,
    "pageSize": 100,
    "totalPages": 1,
    "totalCount": 2,
    "data": [
      {
        "accessLevel": "OWNER",
        "id": 4583173393803140,
        "name": "sheet 1",
        "version": 5,
        "permalink": "https://app.smartsheet.com/b/home?lx=xUefSOIYmn07iJJesvSHCQ",
        "createdAt": "2015-06-05T20:05:29Z",
        "modifiedAt": "2015-06-05T20:05:43Z"
      },
      {
        "accessLevel": "OWNER",
        "id": 2331373580117892,
        "name": "sheet 2",
        "version": 86,
        "permalink": "https://app.smartsheet.com/b/home?lx=xUefSOIYmn07iJJrthEFTG",
        "createdAt": "2015-06-05T20:05:29Z",
        "modifiedAt": "2015-06-05T20:05:43Z"
      }
    ]
  }
}

List User Templates

Lists user-created templates. | key: templatesList

Input	Notes	Example
Connection	The Smartsheet connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the specified page is returned.	false
Pagination Page	The 1-based page number to return.	1
Pagination Page Size	The maximum number of items to return per page.

{
  "data": {
    "pageNumber": 1,
    "pageSize": 100,
    "totalPages": 1,
    "totalCount": 2,
    "data": [
      {
        "id": 7116448184199044,
        "name": "Project Tracking",
        "type": "sheet",
        "accessLevel": "OWNER",
        "description": "Track project tasks, milestones, and deadlines"
      },
      {
        "id": 4864648370513796,
        "name": "Sales Pipeline",
        "type": "sheet",
        "accessLevel": "VIEWER",
        "description": "Manage sales opportunities and pipeline stages"
      }
    ]
  }
}

List Users

Lists all users in the organization. | key: listUsers

Input	Notes	Example
Connection	The Smartsheet connection to use.
Email	The email address to filter users by.
Fetch All	When true, automatically fetches all pages of results. When false, only the specified page is returned.	false
Modified Since	When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified. Format: ISO 8601 (e.g. 2023-01-01T00:00:00Z).
Pagination Page	The 1-based page number to return.	1
Pagination Page Size	The maximum number of items to return per page.

{
  "data": {
    "pageNumber": 1,
    "pageSize": 100,
    "totalPages": 1,
    "totalCount": 1,
    "data": [
      {
        "id": 94094820842,
        "email": "john.doe@smartsheet.com",
        "name": "John Doe",
        "firstName": "John",
        "lastName": "Doe",
        "profileImage": {
          "imageId": "u!1!8ljad7w9-aY!AsDeH0wWv1Y!y9VvAgUOFdg",
          "height": 1050,
          "width": 1050
        },
        "status": "ACTIVE",
        "admin": true,
        "licensedSheetCreator": true,
        "groupAdmin": true,
        "resourceViewer": true,
        "sheetCount": 3,
        "lastLogin": "2016-08-15T18:32:47Z",
        "customWelcomeScreenViewed": "2016-08-12T12:15:47Z"
      }
    ]
  }
}

List Webhooks

Lists all webhooks owned by the authenticated user. | key: listWebhooks

Input	Notes	Example
Connection	The Smartsheet connection to use.
Show All	By default only webhooks whose callback URLs match a flow in the current instance are shown. Toggle this to 'true' to show all webhooks (even those for other apps and instances).	false

{
  "data": [
    {
      "id": 4503604829677444,
      "name": "Webhook #5",
      "scope": "sheet",
      "scopeObjectId": 6761855684241284,
      "events": [
        "*.*"
      ],
      "callbackUrl": "http://www.myApp.com/webhooks",
      "sharedSecret": "216ejjzfoo17mq1q8xs7d4hu8b",
      "enabled": true,
      "status": "ENABLED",
      "version": 1,
      "subscope": {
        "columnIds": [
          7318427511613316,
          7318427511613123
        ]
      },
      "createdAt": "2020-01-03T14:52:21Z",
      "modifiedAt": "2020-01-04T19:05:40Z"
    }
  ]
}

List Workspaces

Lists all workspaces accessible to the authenticated user. | key: listWorkspaces

Input	Notes	Example
Connection	The Smartsheet connection to use.
Fetch All	When true, automatically fetches all pages of results. When false, only the specified page is returned.	false
Pagination Page	The 1-based page number to return.	1
Pagination Page Size	The maximum number of items to return per page.

{
  "data": {
    "pageNumber": 1,
    "totalPages": 1,
    "totalCount": 1,
    "data": [
      {
        "id": 3776173869164420,
        "name": "My Test Workspace",
        "accessLevel": "OWNER",
        "permalink": "https://app.smartsheet.com/workspaces/M5hwX6XMQxfvRr9xHh77XgRWGhW8VWMXrX54mhw1"
      }
    ]
  }
}

Move Folder

Moves a folder to a specified destination. | key: moveFolder

Input	Notes	Example
Connection	The Smartsheet connection to use.
Destination Folder ID	The unique identifier for the folder. Folders can contain sheets, sights, reports, templates, and other folders.	375893453
Folder ID	The unique identifier for the folder. Folders can contain sheets, sights, reports, templates, and other folders.	375893453

{
  "data": {
    "message": "SUCCESS",
    "resultCode": 0,
    "result": {
      "id": 7324970943571844,
      "name": "New Folder Name",
      "permalink": "https://app.smartsheet.com/folders/CqwF74MP2VF73F4jV9XWHVgPvJp7jJmw9h2CrF81"
    }
  }
}

Move Rows

Moves rows to another sheet. | key: moveRows

Input	Notes	Example
Connection	The Smartsheet connection to use.
Row IDs	The IDs of the rows to move or copy from the source sheet	6830028284938
Sheet ID	The unique identifier for the sheet.	4583173393803140
Destination Sheet ID	The unique identifier of the sheet to move or copy rows into.

{
  "data": {
    "destinationSheetId": 2258256056870788,
    "rowMappings": [
      {
        "from": 145417762563972,
        "to": 4508365800925060
      },
      {
        "from": 8026717110462340,
        "to": 2256565987239812
      }
    ]
  }
}

Move Sheet

Moves a sheet to a specified destination. | key: moveSheet

Input	Notes	Example
Connection	The Smartsheet connection to use.
Destination ID	The ID of the destination container (when copying or moving a sheet or a folder).
Destination Type	The type of container to copy or move the resource into.	home
Sheet ID	The unique identifier for the sheet.	4583173393803140

{
  "data": {
    "message": "SUCCESS",
    "resultCode": 0,
    "result": {
      "id": 4366633289443204,
      "name": "New Sheet Name",
      "accessLevel": "OWNER",
      "permalink": "https://app.smartsheet.com/b/home?lx=lB0JaOh6AX1wGwqxsQIMaA"
    }
  }
}

Raw Request

Sends a raw HTTP request to the Smartsheet API. | key: rawRequest

Input	Notes	Example
Connection	The Smartsheet connection to use.
Data	The HTTP body payload to send to the URL.	{"exampleKey": "Example Data"}
Debug Request	Enabling this flag will log out the current request.	false
File Data	File Data to be sent as a multipart form upload.	[{key: "example.txt", value: "My File Contents"}]
File Data File Names	File names to apply to the file data inputs. Keys must match the file data keys above.
Form Data	The Form Data to be sent as a multipart form upload.	[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header	A list of headers to send with the request.	User-Agent: curl/7.64.1
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Method	The HTTP method to use.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Timeout	The maximum time that a client will await a response to its request	2000
URL	Input the path only (/reports), The base URL is already included (https://api.smartsheet.com/2.0). For example, to connect to https://api.smartsheet.com/2.0/reports, only /reports is entered in this field.	/reports
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false

Search Sheets

Searches sheets for a specified phrase. | key: searchSheet

Input	Notes	Example
Connection	The Smartsheet connection to use.
Search Query	The text to search for across sheets, rows, and cells.
Sheet ID (Optional)	The ID of the sheet to search. Omit to search all sheets.	4583173393803140

{
  "data": {
    "results": [
      {
        "contextData": [
          "Row 1"
        ],
        "objectId": 1888207043356548,
        "objectType": "discussion",
        "parentObjectId": 7141187195824004,
        "parentObjectName": "Sheet 1",
        "parentObjectType": "sheet",
        "text": "discussion stuff goes here"
      },
      {
        "contextData": [
          "Row 1"
        ],
        "objectId": 2711817823774596,
        "objectType": "row",
        "parentObjectId": 2583735121012612,
        "parentObjectName": "Sheet 2",
        "parentObjectType": "sheet",
        "text": "row stuff goes here"
      }
    ],
    "totalCount": 2
  }
}

Send Sheet

Sends a sheet via email to specified recipients. | key: sheetSend

Input	Notes	Example
CC Me	Indicates whether to send a copy of the email to the sender	false
Connection	The Smartsheet connection to use.
Emails	The email addresses of recipients to send the document to.
Format	The file format to use when sending the sheet.	EXCEL
Group IDs	The group IDs of recipients to send the document to.
Message	The message of the email.
Paper Size	The paper size to use when generating the PDF.	LETTER
Sheet ID	The unique identifier for the sheet.	4583173393803140
Subject	The subject line of the email.

{
  "data": {
    "message": "SUCCESS",
    "resultCode": 0
  }
}

Set Sheet Publish Status

Sets the publish status of a sheet. | key: setSheetPublish

Input	Notes	Example
Connection	The Smartsheet connection to use.
iCal Enabled	If true, a webcal is available for the calendar in the sheet	false
Read Only Full Accessible By	Indicates who can access the 'Read-Only Full' view of the published sheet:	ALL
Read Only Full Default View	Indicates which view the user has set for a read-only, default view of the published sheet	CALENDAR
Read Only Full Enabled	If true, a rich version of the sheet is published with the ability to download row attachments and discussions	true
Read Only Lite Enabled	If true, a lightweight version of the sheet is published without row attachments and discussions	false
Read Write Accessible By	Indicates who can access the 'Edit by Anyone' view of the published sheet:	ALL
Read Write Default View	Indicates which view the user has set for a read-write, default view of the published sheet	CALENDAR
Read Write Enabled	If true,a rich version of the sheet is published with the ability to edit cells and manage attachments and discussions	true
Sheet ID	The unique identifier for the sheet.	4583173393803140

{
  "data": {
    "message": "SUCCESS",
    "resultCode": 0,
    "result": {
      "icalEnabled": false,
      "readOnlyFullEnabled": false,
      "readOnlyLiteEnabled": true,
      "readOnlyLiteUrl": "http://publish.smartsheet.com/9862638d9c444014b5d7a114d436e99d",
      "readWriteEnabled": false
    }
  }
}

Update Folder

Updates the name of a folder. | key: updateFolder

Input	Notes	Example
Connection	The Smartsheet connection to use.
Folder ID	The unique identifier for the folder. Folders can contain sheets, sights, reports, templates, and other folders.	375893453
Folder Name	The display name for the folder.	My Folder

{
  "data": {
    "message": "SUCCESS",
    "resultCode": 0,
    "result": {
      "id": 5220505688008580,
      "name": "New Folder Name",
      "permalink": "https://app.smartsheet.com/folders/7QpC5vFJP3JXwgq7qqCgfCjP4cGmvj5GHh7G2wc1"
    }
  }
}

Update Sheet

Updates the properties of a sheet. | key: updateSheet

Input	Notes	Example
Connection	The Smartsheet connection to use.
New Name	The updated display name for the sheet.
Sheet ID	The unique identifier for the sheet.	4583173393803140

{
  "data": {
    "message": "SUCCESS",
    "resultCode": 0,
    "result": {
      "id": 7960873114331012,
      "name": "New Sheet Name",
      "accessLevel": "OWNER",
      "userSettings": {
        "criticalPathEnabled": true
      },
      "projectSettings": {
        "workingDays": [
          "MONDAY",
          "TUESDAY",
          "WEDNESDAY"
        ],
        "nonWorkingDays": [
          "2018-01-01"
        ],
        "lengthOfDay": 6
      },
      "permalink": "https://app.smartsheet.com/b/home?lx=RE8LkzA48kPRWTzcgEYOga"
    }
  }
}

Update Workspace

Updates the properties of a workspace. | key: updateWorkspace

Input	Notes	Example
Connection	The Smartsheet connection to use.
Name	The updated display name for the workspace.
Workspace ID	The unique identifier for the workspace.	843750385

{
  "data": {
    "message": "SUCCESS",
    "resultCode": 0,
    "result": {
      "accessLevel": "OWNER",
      "id": 7960873114331012,
      "name": "Updated workspace",
      "permalink": "https://app.smartsheet.com/b/home?lx=rBU8QqUVPCJ3geRgl7L8yQ"
    }
  }
}

Changelog

2026-03-31

Various modernizations and documentation updates

2026-03-30

Added documentation improvements and various modernizations

2026-03-05

Added inline data sources for contacts and users to enable dynamic dropdown selection

2025-08-29

Initial release of Smartsheet component with comprehensive sheet and workspace management capabilities

Manage sheets, rows, and workspaces in the Smartsheet platform

Description​

API Documentation​

A Note on Webhooks​

Connections​

API Key​

Configure the Connection​

OAuth 2.0 (Deprecated)​

Prerequisites​

Setup Steps​

Configure the Connection​

OAuth 2.0​

Prerequisites​

Setup Steps​

Configure the Connection​

Triggers​

Webhook​

How It Works​

Configuration​

Data Sources​

Select Attachment​

Select Column​

Select Contact​

Select Discussion​

Select Folder​

Select Group​

Select Report​

Select Row​

Select Sheet​

Select User​

Select Webhook​

Select Workspace​

Actions​

Add Column to Sheet​

Add Comment​

Add/Update Row​

Copy Rows​

Copy Sheet​

Create Discussion​

Create Folder​

Create Sheet​

Create Webhook​

Create Workspace​

Delete Column​

Delete Comment​

Delete Discussion​

Delete Folder​

Delete Instance Webhooks​

Delete Row​

Delete Sheet​

Delete Webhook​

Delete Workspace​

Edit Comment​

Get Column​

Get Comment​

Get Contact​

Get Discussion​

Get Folder​

Get Group​

Get Report​

Get Row​

Get Sheet​

Get Sheet Attachment​

Get Sheet Publish Status​

Get Sheet Version​

Get User​

Get Webhook​

Get Workspace​

List Attachments on Row​

List Attachments on Sheet​

List Columns​

List Contacts​

List Discussion Attachments​

List Discussions​

List Events​

List Favorites​

List Folders​

List Groups​

List Home Contents​

List Public Templates​

Description

API Documentation

A Note on Webhooks

Connections

API Key

Configure the Connection

OAuth 2.0 (Deprecated)

Prerequisites

Setup Steps

Configure the Connection

OAuth 2.0

Prerequisites

Setup Steps

Configure the Connection

Triggers

Webhook

How It Works

Configuration

Data Sources

Select Attachment

Select Column

Select Contact

Select Discussion

Select Folder

Select Group

Select Report

Select Row

Select Sheet

Select User

Select Webhook

Select Workspace

Actions

Add Column to Sheet

Add Comment

Add/Update Row

Copy Rows

Copy Sheet

Create Discussion

Create Folder

Create Sheet

Create Webhook

Create Workspace

Delete Column

Delete Comment

Delete Discussion

Delete Folder

Delete Instance Webhooks

Delete Row

Delete Sheet

Delete Webhook

Delete Workspace

Edit Comment

Get Column

Get Comment

Get Contact

Get Discussion

Get Folder

Get Group

Get Report

Get Row

Get Sheet

Get Sheet Attachment

Get Sheet Publish Status

Get Sheet Version

Get User

Get Webhook

Get Workspace

List Attachments on Row

List Attachments on Sheet

List Columns

List Contacts

List Discussion Attachments

List Discussions

List Events

List Favorites

List Folders

List Groups

List Home Contents

List Public Templates

List Reports