Skip to main content

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.

June 2026 Pagination Migration​

Smartsheet is deprecating the includeAll, page, pageSize, totalCount, and totalPages parameters on list endpoints on June 3, 2026.

The following changes are in effect as of the 2026-05-07 release:

  • Auto-pagination: migrated list operations now paginate internally. Customers no longer need to set Include All to retrieve all results.
  • Response shape change: the response metadata fields pageNumber, pageSize, totalCount, and totalPages are no longer present on migrated list responses. Flows reading these fields must be updated to use the data array directly.
  • Deprecated inputs: Include All, Page, and Page Size remain on actions for backward compatibility but their values no longer reach the API on migrated actions. These inputs will be removed in a future major release.
  • Templates: List — a new optional input Workspace ID For Templates is available. When set, the action fetches templates from that workspace in a single API call. Without it, the action fetches templates across all workspaces (slower; rate-limit pressure increases with workspace count).
  • Webhook list ordering: results from webhook list operations are now returned in creation-date descending order (previously name ascending), reflecting Smartsheet's updated default sort order.
  • Not yet migrated: Templates: List Public is pending research into a replacement endpoint and will be addressed in a follow-up release.
  • Breaking change — removed fields: Get Workspace and Get Folder responses no longer include ownerInfo or sheetVersion — Smartsheet removed these from the new /metadata endpoint. The source field is preserved.
  • Load All input deprecated: the Load All input on Get Workspace has no effect after migration — Smartsheet's API no longer supports recursive nested expansion in a single response. The input is retained for backward compatibility.

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.
InputNotesExample
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​

  1. Log in to Smartsheet
  2. Navigate to the profile icon (bottom left) and select Developer Tools
  3. Create a developer profile if one does not already exist
  4. Click Create New App
  5. 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
  6. 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.
InputNotesExample
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​

  1. Log in to Smartsheet
  2. Navigate to the profile icon (bottom left) and select Developer Tools
  3. Create a developer profile if one does not already exist
  4. Click Create New App
  5. 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
  6. 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.
InputNotesExample
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 the 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.

Event Types​

Smartsheet webhooks support two scopes, each with a different set of event types.

Available Event Types
ScopeEventDescription
sheet*.*Required for sheet webhooks. Subscribes to all sheet-related events (rows, columns, cells, attachments, discussions, comments).
plan*.*Subscribes to all plan-level events.
planuser.seatType.updatedTriggered when a user's seat type is updated within the plan.

Refer to the Smartsheet Webhook Event Types reference for the complete and up-to-date list.

Returned Data​

The callback contains a "skinny" payload — an array of events identifying the changed objects and event types, without the full object data. Use a follow-up action (such as Get Sheet or Get Row) to retrieve full record details when needed.

Example Event Payload
{
  "nonce": "ed6dac98-577a-4b95-a01a-94a266769ed1",
  "timestamp": "2026-05-01T12:34:56.000+00:00",
  "webhookId": 8951687911106436,
  "scope": "sheet",
  "scopeObjectId": 285065612683140,
  "events": [
    {
      "objectType": "row",
      "eventType": "updated",
      "id": 1234567890123456,
      "userId": 9876543210123456,
      "timestamp": "2026-05-01T12:34:56.000+00:00"
    },
    {
      "objectType": "cell",
      "eventType": "updated",
      "rowId": 1234567890123456,
      "columnId": 7318427511613316,
      "userId": 9876543210123456,
      "timestamp": "2026-05-01T12:34:56.000+00:00"
    }
  ]
}
Example Payload for Webhook⤓
Loading…

Data Sources​

Select Attachment​

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

InputNotesExample
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

InputNotesExample
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

InputNotesExample
Connection

The Smartsheet connection to use.

Select Discussion​

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

InputNotesExample
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

InputNotesExample
Connection

The Smartsheet connection to use.

Select Group​

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

InputNotesExample
Connection

The Smartsheet connection to use.

Select Report​

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

InputNotesExample
Connection

The Smartsheet connection to use.

Select Row​

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

InputNotesExample
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

InputNotesExample
Connection

The Smartsheet connection to use.

Select User​

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

InputNotesExample
Connection

The Smartsheet connection to use.

Select Webhook​

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

InputNotesExample
Connection

The Smartsheet connection to use.

Select Webhook Scope Column​

Select columns from the sheet used as the webhook scope. | key: selectWebhookScopeColumn | type: picklist

InputNotesExample
Connection

The Smartsheet connection to use.

Scope Object ID

The unique identifier for the sheet.

4583173393803140

Select Workspace​

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

InputNotesExample
Connection

The Smartsheet connection to use.

Actions​

Add Column to Sheet​

Adds a column to a sheet. | key: columnsAddToSheet

InputNotesExample
Connection

The Smartsheet connection to use.

Description

Additional context or instructions displayed below the column header.

Formula

The formula for a column.

Hidden

When true, the column is hidden from view in the sheet.

false
Position Index

The 0-based position where the column should be inserted in the sheet.

0
Locked

When true, the column is locked and cannot be edited by users without appropriate permissions.

false
Options

A JSON array of selectable values for picklist or multi-picklist columns.

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

When true, cell value validation rules are enforced for the column.

false
Width

Display width of the column in pixels.

Example Payload for Add Column to Sheet⤓
Loading…

Add Comment​

Adds a comment to a discussion. | key: commentsCreate

InputNotesExample
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.

Example Payload for Add Comment⤓
Loading…

Add/Update Row​

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

InputNotesExample
Allow Partial Success

When true, allows the bulk operation to partially succeed if some rows fail validation rather than failing the entire request.

false
Column Values

A list of column names mapped to the values to write into them.

Connection

The Smartsheet connection to use.

Dynamic Columns Values

A JSON array of objects mapping column titles to cell values for the row. Use this when column titles are easier to reference than column IDs.

[
  {
    "key": "My First Column",
    "value": "123"
  },
  {
    "key": "My Second Column",
    "value": "456"
  }
]
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)

The unique identifier of an existing row to update. Omit to add a new row instead.

8908091207493508
Example Payload for Add/Update Row⤓
Loading…

Copy Rows​

Copies rows to another sheet. | key: copyRows

InputNotesExample
Connection

The Smartsheet connection to use.

Row IDs

The unique identifiers 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.

Example Payload for Copy Rows⤓
Loading…

Copy Sheet​

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

InputNotesExample
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
Example Payload for Copy Sheet⤓
Loading…

Create Discussion​

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

InputNotesExample
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
Example Payload for Create Discussion⤓
Loading…

Create Folder​

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

InputNotesExample
Connection

The Smartsheet connection to use.

Folder ID

The unique identifier of the parent folder to create a subfolder within. Omit to create a top-level home folder.

375893453
Folder Name

The display name for the folder.

My Folder
Workspace ID (Optional)

The unique identifier of the workspace to create the folder in. Omit to create the folder outside of a workspace.

843750385
Example Payload for Create Folder⤓
Loading…

Create Sheet​

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

InputNotesExample
Columns

See Smartsheet API documentation for additional information about column types.

[
  {
    "title": "Favorite",
    "type": "CHECKBOX",
    "symbol": "STAR"
  },
  {
    "title": "Primary Column",
    "primary": true,
    "type": "TEXT_NUMBER"
  }
]
Connection

The Smartsheet connection to use.

Folder ID

The unique identifier of the folder to create the sheet in. 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
Example Payload for Create Sheet⤓
Loading…

Create Webhook​

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

InputNotesExample
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
Subscope Column IDs

When provided, the webhook only fires when these specific columns are modified. Leave empty to trigger on any change to the sheet. Use the List Columns action to find column IDs for a sheet.

7960873114331012

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.

Example Payload for Create Webhook⤓
Loading…

Create Workspace​

Creates a new workspace. | key: createWorkspace

InputNotesExample
Connection

The Smartsheet connection to use.

Workspace Name

The display name for the workspace.

New Workspace
Example Payload for Create Workspace⤓
Loading…

Delete Column​

Deletes a column from a sheet. | key: columnDelete

InputNotesExample
Column ID

The unique identifier for the column.

7960873114331012
Connection

The Smartsheet connection to use.

Sheet ID

The unique identifier for the sheet.

4583173393803140
Example Payload for Delete Column⤓
Loading…

Delete Comment​

Deletes a comment by its ID. | key: commentDelete

InputNotesExample
Comment ID

The unique identifier for the comment.

3888061631401860
Connection

The Smartsheet connection to use.

Sheet ID

The unique identifier for the sheet.

4583173393803140
Example Payload for Delete Comment⤓
Loading…

Delete Discussion​

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

InputNotesExample
Connection

The Smartsheet connection to use.

Discussion ID

The unique identifier for the discussion.

3650061106619268
Sheet ID

The unique identifier for the sheet.

4583173393803140
Example Payload for Delete Discussion⤓
Loading…

Delete Folder​

Deletes a folder by its ID. | key: deleteFolder

InputNotesExample
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
Example Payload for Delete Folder⤓
Loading…

Delete Instance Webhooks​

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

InputNotesExample
Connection

The Smartsheet connection to use.

Example Payload for Delete Instance Webhooks⤓
Loading…

Delete Row​

Deletes a row from a sheet. | key: deleteRow

InputNotesExample
Connection

The Smartsheet connection to use.

Row ID

The unique identifier for the row.

8908091207493508
Sheet ID

The unique identifier for the sheet.

4583173393803140
Example Payload for Delete Row⤓
Loading…

Delete Sheet​

Deletes a sheet by its ID. | key: deleteSheet

InputNotesExample
Connection

The Smartsheet connection to use.

Sheet ID

The unique identifier for the sheet.

4583173393803140
Example Payload for Delete Sheet⤓
Loading…

Delete Webhook​

Deletes a webhook by its ID. | key: deleteWebhook

InputNotesExample
Connection

The Smartsheet connection to use.

Webhook ID

The unique identifier for the webhook.

8444254503626628
Example Payload for Delete Webhook⤓
Loading…

Delete Workspace​

Deletes a workspace by its ID. | key: deleteWorkspace

InputNotesExample
Connection

The Smartsheet connection to use.

Workspace ID

The unique identifier for the workspace.

843750385
Example Payload for Delete Workspace⤓
Loading…

Edit Comment​

Edits a comment by its ID. | key: commentEdit

InputNotesExample
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.

Example Payload for Edit Comment⤓
Loading…

Get Column​

Retrieves a column by its ID. | key: columnGet

InputNotesExample
Column ID

The unique identifier for the column.

7960873114331012
Connection

The Smartsheet connection to use.

Sheet ID

The unique identifier for the sheet.

4583173393803140
Example Payload for Get Column⤓
Loading…

Get Comment​

Retrieves a comment by its ID. | key: commentGet

InputNotesExample
Comment ID

The unique identifier for the comment.

3888061631401860
Connection

The Smartsheet connection to use.

Sheet ID

The unique identifier for the sheet.

4583173393803140
Example Payload for Get Comment⤓
Loading…

Get Contact​

Retrieves a contact by its ID. | key: getContact

InputNotesExample
Connection

The Smartsheet connection to use.

Contact ID

The unique identifier for the contact.

Example Payload for Get Contact⤓
Loading…

Get Discussion​

Retrieves a discussion by its ID. | key: discussionGet

InputNotesExample
Connection

The Smartsheet connection to use.

Discussion ID

The unique identifier for the discussion.

3650061106619268
Sheet ID

The unique identifier for the sheet.

4583173393803140
Example Payload for Get Discussion⤓
Loading…

Get Folder​

Retrieves a folder by its ID. | key: getFolder

InputNotesExample
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
Example Payload for Get Folder⤓
Loading…

Get Group​

Retrieves a group by its ID. | key: getGroup

InputNotesExample
Connection

The Smartsheet connection to use.

Group ID

The unique identifier for the group.

375893453
Example Payload for Get Group⤓
Loading…

Get Report​

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

InputNotesExample
Connection

The Smartsheet connection to use.

Pagination Page (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

1
Pagination Page Size (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

Report ID

The unique identifier for the report.

2973569197942660

Get Row​

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

InputNotesExample
Connection

The Smartsheet connection to use.

Row ID

The unique identifier for the row.

8908091207493508
Sheet ID

The unique identifier for the sheet.

4583173393803140
Example Payload for Get Row⤓
Loading…

Get Sheet​

Retrieves a sheet by its ID. | key: getSheet

InputNotesExample
Connection

The Smartsheet connection to use.

Pagination Page (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

1
Pagination Page Size (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

Sheet ID

The unique identifier for the sheet.

4583173393803140
Example Payload for Get Sheet⤓
Loading…

Get Sheet Attachment​

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

InputNotesExample
Attachment ID

The unique identifier for the attachment.

1018169196216196
Connection

The Smartsheet connection to use.

Sheet ID

The unique identifier for the sheet.

4583173393803140
Example Payload for Get Sheet Attachment⤓
Loading…

Get Sheet Publish Status​

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

InputNotesExample
Connection

The Smartsheet connection to use.

Sheet ID

The unique identifier for the sheet.

4583173393803140
Example Payload for Get Sheet Publish Status⤓
Loading…

Get Sheet Version​

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

InputNotesExample
Connection

The Smartsheet connection to use.

Sheet ID

The unique identifier for the sheet.

4583173393803140
Example Payload for Get Sheet Version⤓
Loading…

Get User​

Retrieves a user by their ID. | key: getUser

InputNotesExample
Connection

The Smartsheet connection to use.

User ID

The unique identifier of the user to fetch. Enter "me" to retrieve the currently authenticated user.

Example Payload for Get User⤓
Loading…

Get Webhook​

Retrieves a webhook by its ID. | key: getWebhook

InputNotesExample
Connection

The Smartsheet connection to use.

Webhook ID

The unique identifier for the webhook.

8444254503626628
Example Payload for Get Webhook⤓
Loading…

Get Workspace​

Retrieves a workspace by its ID. | key: getWorkspace

InputNotesExample
Connection

The Smartsheet connection to use.

Load All

Preserved for backward compatibility. Smartsheet's redesigned API no longer supports recursive nested expansion of folders/contents in a single response; this input has no effect on the migrated action.

false
Workspace ID

The unique identifier for the workspace.

843750385
Example Payload for Get Workspace⤓
Loading…

List Attachments on Row​

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

InputNotesExample
Connection

The Smartsheet connection to use.

Fetch All (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

false
Pagination Page (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

1
Pagination Page Size (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

Row ID

The unique identifier for the row.

8908091207493508
Sheet ID

The unique identifier for the sheet.

4583173393803140
Example Payload for List Attachments on Row⤓
Loading…

List Attachments on Sheet​

Lists all attachments on a sheet. | key: attachmentsListOnSheet

InputNotesExample
Connection

The Smartsheet connection to use.

Fetch All (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

false
Pagination Page (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

1
Pagination Page Size (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

Sheet ID

The unique identifier for the sheet.

4583173393803140
Example Payload for List Attachments on Sheet⤓
Loading…

List Columns​

Lists all columns on a sheet. | key: columnsListOnSheet

InputNotesExample
Connection

The Smartsheet connection to use.

Fetch All (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

false
Pagination Page (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

1
Pagination Page Size (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

Sheet ID

The unique identifier for the sheet.

4583173393803140
Example Payload for List Columns⤓
Loading…

List Contacts​

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

InputNotesExample
Connection

The Smartsheet connection to use.

Fetch All (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

false
Pagination Page (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

1
Pagination Page Size (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

Example Payload for List Contacts⤓
Loading…

List Discussion Attachments​

Lists all attachments on a discussion. | key: discussionListAttachments

InputNotesExample
Connection

The Smartsheet connection to use.

Discussion ID

The unique identifier for the discussion.

3650061106619268
Fetch All (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

false
Pagination Page (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

1
Pagination Page Size (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

Sheet ID

The unique identifier for the sheet.

4583173393803140
Example Payload for List Discussion Attachments⤓
Loading…

List Discussions​

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

InputNotesExample
Connection

The Smartsheet connection to use.

Fetch All (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

false
Pagination Page (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

1
Pagination Page Size (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

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
Example Payload for List Discussions⤓
Loading…

List Events​

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

InputNotesExample
Connection

The Smartsheet connection to use.

Max Count

The maximum number of events to return in a single response.

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

The pagination cursor used to retrieve the next set of events. Returned by a previous request.

XyzAb1234cdefghijklmnofpq
Example Payload for List Events⤓
Loading…

List Favorites​

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

InputNotesExample
Connection

The Smartsheet connection to use.

Fetch All (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

false
Pagination Page (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

1
Pagination Page Size (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

Example Payload for List Favorites⤓
Loading…

List Folders​

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

InputNotesExample
Connection

The Smartsheet connection to use.

Folder ID

The unique identifier of the parent folder whose subfolders should be listed. Omit to list top-level home folders.

375893453
Fetch All (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

false
Pagination Page (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

1
Pagination Page Size (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

Workspace ID (Optional)

The unique identifier of the workspace whose folders should be listed. Omit to list folders outside of a workspace.

843750385
Example Payload for List Folders⤓
Loading…

List Groups​

Lists all groups in the organization. | key: listGroups

InputNotesExample
Connection

The Smartsheet connection to use.

Fetch All (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

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 (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

1
Pagination Page Size (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

Example Payload for List Groups⤓
Loading…

List Home Contents​

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

InputNotesExample
Connection

The Smartsheet connection to use.

Example Payload for List Home Contents⤓
Loading…

List Public Templates​

Lists publicly available templates. | key: templatesListPublic

InputNotesExample
Connection

The Smartsheet connection to use.

Fetch All (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

false
Pagination Page (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

1
Pagination Page Size (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

Example Payload for List Public Templates⤓
Loading…

List Reports​

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

InputNotesExample
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).

Example Payload for List Reports⤓
Loading…

List Sheets​

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

InputNotesExample
Connection

The Smartsheet connection to use.

Fetch All (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

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 (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

1
Pagination Page Size (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

Example Payload for List Sheets⤓
Loading…

List User Templates​

Lists user-created templates. | key: templatesList

InputNotesExample
Connection

The Smartsheet connection to use.

Fetch All (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

false
Pagination Page (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

1
Pagination Page Size (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

Workspace ID

Optional. When supplied, fetches templates from this single workspace only — fast, single API call. When omitted, the action paginates ALL workspaces and aggregates templates from each — this preserves backwards compatibility with the legacy GET /templates response shape but may be slow and rate-limit-sensitive on accounts with many workspaces (chunked-parallel concurrency 5). Recommend supplying a workspace ID for production flows.

843750385
Example Payload for List User Templates⤓
Loading…

List Users​

Lists all users in the organization. | key: listUsers

InputNotesExample
Connection

The Smartsheet connection to use.

Email

The email address to filter users by.

Fetch All (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

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 (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

1
Pagination Page Size (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

Example Payload for List Users⤓
Loading…

List Webhooks​

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

InputNotesExample
Connection

The Smartsheet connection to use.

Show All

When true, returns all webhooks for the account (including those for other apps and instances). When false, returns only webhooks whose callback URLs match a flow in the current instance.

false
Example Payload for List Webhooks⤓
Loading…

List Workspaces​

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

InputNotesExample
Connection

The Smartsheet connection to use.

Fetch All (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

false
Pagination Page (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

1
Pagination Page Size (Deprecated)

DEPRECATED — has no effect on actions migrated for the 2026-06-03 Smartsheet sunset. Preserved for backwards compatibility on those actions; will be removed in a future major release.

Example Payload for List Workspaces⤓
Loading…

Move Folder​

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

InputNotesExample
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
Example Payload for Move Folder⤓
Loading…

Move Rows​

Moves rows to another sheet. | key: moveRows

InputNotesExample
Connection

The Smartsheet connection to use.

Row IDs

The unique identifiers 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.

Example Payload for Move Rows⤓
Loading…

Move Sheet​

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

InputNotesExample
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
Example Payload for Move Sheet⤓
Loading…

Raw Request​

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

InputNotesExample
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

InputNotesExample
Connection

The Smartsheet connection to use.

Search Query

The text to search for across sheets, rows, and cells.

Sheet ID (Optional)

The unique identifier of the sheet to search within. Omit to search across all sheets.

4583173393803140
Example Payload for Search Sheets⤓
Loading…

Send Sheet​

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

InputNotesExample
CC Me

When true, sends 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.

Example Payload for Send Sheet⤓
Loading…

Set Sheet Publish Status​

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

InputNotesExample
Connection

The Smartsheet connection to use.

iCal Enabled

When true, a webcal feed is published for the calendar in the sheet.

false
Read Only Full Accessible By

The audience that can access the read-only full view of the published sheet. ALL allows anyone with the link; ORG restricts access to the organization.

ALL
Read Only Full Default View

The default layout shown when viewers open the read-only full published sheet.

CALENDAR
Read Only Full Enabled

When true, publishes a rich read-only version of the sheet that allows viewers to download row attachments and discussions.

true
Read Only Lite Enabled

When true, publishes a lightweight read-only version of the sheet without row attachments or discussions.

false
Read Write Accessible By

The audience that can edit the published sheet. ALL allows anyone with the link; ORG restricts access to the organization.

ALL
Read Write Default View

The default layout shown when editors open the read-write published sheet.

CALENDAR
Read Write Enabled

When true, publishes a rich version of the sheet that allows editors to modify cells and manage attachments and discussions.

true
Sheet ID

The unique identifier for the sheet.

4583173393803140
Example Payload for Set Sheet Publish Status⤓
Loading…

Update Folder​

Updates the name of a folder. | key: updateFolder

InputNotesExample
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
Example Payload for Update Folder⤓
Loading…

Update Sheet​

Updates the properties of a sheet. | key: updateSheet

InputNotesExample
Connection

The Smartsheet connection to use.

New Name

The updated display name for the sheet.

Sheet ID

The unique identifier for the sheet.

4583173393803140
Example Payload for Update Sheet⤓
Loading…

Update Workspace​

Updates the properties of a workspace. | key: updateWorkspace

InputNotesExample
Connection

The Smartsheet connection to use.

Name

The updated display name for the workspace.

Workspace ID

The unique identifier for the workspace.

843750385
Example Payload for Update Workspace⤓
Loading…

Changelog​

2026-05-08​

Updated list actions to use Smartsheet's new cursor-based pagination ahead of the June 3, 2026 deprecation of includeAll, page, pageSize, totalCount, and totalPages:

  • List Workspaces, Select Workspace, and Select Folder now paginate automatically using Smartsheet's lastKey cursor
  • List Webhooks, Create Webhook, Delete Instance Webhooks, and Select Webhook now paginate automatically; webhook results are now ordered by creation date descending (previously name ascending)
  • Get Workspace and Get Folder now fetch metadata and children in parallel to replace the removed single-call expansion endpoint; List Folders now filters children client-side by type
  • Templates: List now auto-paginates across all workspaces when no scope is provided; added optional Workspace ID For Templates input to limit results to a single workspace
  • Include All, Page, and Page Size inputs are retained for backward compatibility but no longer have any effect; labels updated with (Deprecated) suffix
  • Templates: List Public is not yet migrated — replacement endpoint research is pending
  • Breaking change: Get Workspace and Get Folder responses no longer include ownerInfo or sheetVersion fields, which Smartsheet removed from the replacement endpoint
  • Load All on Get Workspace no longer has any effect — Smartsheet's API no longer supports recursive nested expansion in a single response; input retained for backward compatibility

2026-04-30​

Various modernizations and documentation updates

2026-04-23​

Added optional Subscope Column IDs input to the Create Webhook action, enabling column-level webhook filtering

2026-03-31​

Various modernizations and documentation updates

2026-03-30​

Various modernizations and documentation updates

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