Skip to main content
Smartsheet
Previewv1.3.0
203 actions · 9 events · 2 auth methods
Project ManagementIAM

Getting Started

1

Create or Select a Project

Set up a new project or select an existing one. See Organizations & Projects.
2

Configure the Connector

Enable the connector and set up a Connector Profile in your project. See Setup Connector Profile.

Connector Profile · OAuth 2.0

Requires registering an app in Smartsheet Developer Tools.

Connector Profile · API Key

Best for personal scripts and single-user integrations. Access is scoped to the token creator’s permissions.
3

Link an Account

Link an account from the dashboard (or via StackOne Hub).See the guide for the authentication type chosen in the Connector Profile:

Link Account · OAuth 2.0

Link Account · API Key

4

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.

Actions

|
203 actions
Action
Description
Required scopes
List Attachments
Retrieve a paginated list of all attachments on a sheet via GET /sheets/{sheetId}/attachments
Add URL Attachment To Sheet
Attach a URL to a sheet via POST /sheets/{sheetId}/attachments
Get Attachment
Retrieve a specific attachment by ID via GET /sheets/{sheetId}/attachments/{attachmentId}
Delete Attachment
Delete an attachment from a sheet via DELETE /sheets/{sheetId}/attachments/{attachmentId}
List Row Attachments
Retrieve all attachments on a specific row via GET /sheets/{sheetId}/rows/{rowId}/attachments
List Attachment Versions
Retrieve all versions of an attachment via GET /sheets/{sheetId}/attachments/{attachmentId}/versions
Delete Attachment Versions
Delete all versions of an attachment via DELETE /sheets/{sheetId}/attachments/{attachmentId}/versions
List Automation Rules
Retrieve all automation rules on a sheet via GET /sheets/{sheetId}/automationrules
Get Automation Rule
Retrieve a specific automation rule via GET /sheets/{sheetId}/automationrules/{automationRuleId}
Update Automation Rule
Update an automation rule via PUT /sheets/{sheetId}/automationrules/{automationRuleId}
Delete Automation Rule
Delete an automation rule via DELETE /sheets/{sheetId}/automationrules/{automationRuleId}
List Contacts
Retrieve a paginated list of the authenticated user’s Smartsheet contacts via GET /contacts
Get Contact
Retrieve a specific contact’s details by ID via GET /contacts/{contactId}
List Cross-sheet References
Retrieve all cross-sheet references on a sheet via GET /sheets/{sheetId}/crosssheetreferences
Create Cross-sheet Reference
Create a cross-sheet reference between two sheets to define a data range for formulas via POST /sheets/{sheetId}/crosssh…
Get Cross-sheet Reference
Retrieve a specific cross-sheet reference via GET /sheets/{sheetId}/crosssheetreferences/{crossSheetReferenceId}
List Dashboards
Retrieve a paginated list of all dashboards (sights) accessible to the user via GET /sights
Get Dashboard
Retrieve a dashboard’s full configuration and widgets via GET /sights/{sightId}
Copy Dashboard
Duplicate a dashboard to a destination folder or workspace via POST /sights/{sightId}/copy
Delete Dashboard
Delete a dashboard via DELETE /sights/{sightId}
Get Dashboard Publish Status
Retrieve the publish status of a dashboard via GET /sights/{sightId}/publish
Move Dashboard
Move a dashboard to a different folder or workspace via POST /sights/{sightId}/move
Set Dashboard Publish Status
Set the publish status of a dashboard via PUT /sights/{sightId}/publish
Update Dashboard
Update a dashboard’s name via PUT /sights/{sightId}
Get Dashboard Path
Retrieve the path (folder hierarchy) to a dashboard via GET /sights/{sightId}/path
List Discussions
Retrieve a paginated list of all discussions on a sheet via GET /sheets/{sheetId}/discussions
Create Discussion
Start a new discussion thread on a sheet via POST /sheets/{sheetId}/discussions
Get Comment
Retrieve a single comment by ID from a sheet via GET /sheets/{sheetId}/comments/{commentId}
Edit Comment
Update the text of a comment on a sheet via PUT /sheets/{sheetId}/comments/{commentId}
Delete Comment
Delete a comment from a sheet via DELETE /sheets/{sheetId}/comments/{commentId}
Create Comment
Add a reply comment to an existing discussion thread via POST /sheets/{sheetId}/discussions/{discussionId}/comments
Create Row Discussion
Start a discussion on a specific row via POST /sheets/{sheetId}/rows/{rowId}/discussions
List Row Discussions
Retrieve all discussions on a specific row via GET /sheets/{sheetId}/rows/{rowId}/discussions
Get Discussion
Retrieve a specific discussion by ID via GET /sheets/{sheetId}/discussions/{discussionId}
Delete Discussion
Delete a discussion and all its comments via DELETE /sheets/{sheetId}/discussions/{discussionId}
List Discussion Attachments
Retrieve attachments on a discussion via GET /sheets/{sheetId}/discussions/{discussionId}/attachments
List Events
Retrieve an audit trail of events in the organization via GET /events
List Filtered Events
Retrieve filtered events via POST /filteredEvents
List Favorites
Retrieve the authenticated user’s favorited items via GET /favorites
Add Favorite
Add one item to the current user’s favorites via POST /favorites
Delete Favorites By Type
Remove multiple favorites of a given type via DELETE /favorites/{favoriteType}
Delete Favorite
Remove a single favorite by type and ID via DELETE /favorites/{favoriteType}/{favoriteId}
Check Favorite
Check if an item is favorited via GET /favorites/{favoriteType}/{favoriteId}
List Personal Folders
Retrieve a paginated list of top-level personal folders from the user’s Home via GET /folders/personal
Get Folder (Deprecated)
(DEPRECATED, sunsetting June 2026) Retrieve a folder and its contents by ID via GET /folders/{folderId}. Use get_folder_…
Get Folder Metadata
Retrieve folder metadata (name, dates, permalink) via GET /folders/{folderId}/metadata
List Folder Children
List immediate child resources of a folder (sheets, reports, dashboards, subfolders, templates) via GET /folders/{folder…
Create Folder (Deprecated Path)
(DEPRECATED path, sunsetting June 2026) Create a new subfolder within an existing folder via POST /folders/{folderId}/fo…
Update Folder
Rename a folder via PUT /folders/{folderId}
Delete Folder
Permanently delete a folder and all its contents via DELETE /folders/{folderId}
Copy Folder
Duplicate a folder and its contents to a destination folder or workspace via POST /folders/{folderId}/copy
Move Folder
Move a folder to a different folder or workspace via POST /folders/{folderId}/move
Get Folder Path
Retrieve the hierarchical path to a folder via GET /folders/{folderId}/path
Create Home Folder
Create a new top-level folder in the user’s Home via POST /home/folders
List Groups
Retrieve a paginated list of all groups in the organization via GET /groups, useful for auditing group membership and ma…
Get Group
Retrieve a specific group and its full member list via GET /groups/{groupId}
Create Group
Create a new group in the organization via POST /groups, optionally seeding it with initial members by email
Update Group
Update a group’s name, description, or transfer ownership via PUT /groups/{groupId}
Add Group Members
Add one or more members to an existing group via POST /groups/{groupId}/members
Delete Group Member
Remove a specific member from a group via DELETE /groups/{groupId}/members/{userId}
Delete Group
Permanently delete a group from the organization via DELETE /groups/{groupId}
Get Unified Credentials
Get the current Smartsheet connection’s unified credentials and identity.
IAM Auth Test
Validate the current Smartsheet credentials and return the raw, unmapped /users/me JSON. Bypasses the unified IAM creden…
List Unified Groups
List unified groups in Smartsheet.
Get Unified Group
Get a unified Smartsheet group by ID.
List Unified Organizations
List unified organizations in Smartsheet.
Get Unified Organization
Get a unified Smartsheet organization by ID.
List Unified Resource Types
List unified resource types in Smartsheet.
List Unified Resource Users
List unified resource users in Smartsheet for a given workspace or sheet.
List Unified Roles
List unified roles in Smartsheet.
Get Unified Role
Get a unified Smartsheet role by ID.
List Unified Users
List unified users in Smartsheet.
Get Unified User
Get a unified Smartsheet user by ID.
Update Unified User
Update a unified Smartsheet user by ID.
Delete Unified User
Delete a unified Smartsheet user by ID.
List Proofs
Retrieve all proofs on a sheet via GET /sheets/{sheetId}/proofs
Create Proof
Create a new proof on a row via POST /sheets/{sheetId}/rows/{rowId}/proofs
Update Proof
Update a proof on a sheet via PUT /sheets/{sheetId}/proofs/{proofId}
Delete Proof
Delete a proof from a sheet via DELETE /sheets/{sheetId}/proofs/{proofId}
Create Proof Discussion
Start a discussion on a proof via POST /sheets/{sheetId}/proofs/{proofId}/discussions
Create Proof Requests
Send proof requests (review invitations) via POST /sheets/{sheetId}/proofs/{proofId}/requests
Delete Proof Requests
Delete proof requests from a proof via DELETE /sheets/{sheetId}/proofs/{proofId}/requests
Create Proof Version
Create a new version of a proof via POST /sheets/{sheetId}/proofs/{proofId}/versions
Delete Proof Version
Delete a proof version via DELETE /sheets/{sheetId}/proofs/{proofId}/versions
Get Proof
Retrieve a specific proof by ID via GET /sheets/{sheetId}/proofs/{proofId}
List Proof Versions
Retrieve all versions of a proof via GET /sheets/{sheetId}/proofs/{proofId}/versions
List Proof Attachments
Retrieve attachments on a proof via GET /sheets/{sheetId}/proofs/{proofId}/attachments
List Proof Discussions
Retrieve discussions on a proof via GET /sheets/{sheetId}/proofs/{proofId}/discussions
List Proof Request Actions
Retrieve request actions on a proof via GET /sheets/{sheetId}/proofs/{proofId}/requestactions
List Reports
Retrieve a paginated list of all reports accessible to the user via GET /reports
Get Report
Retrieve a report’s data and configuration via GET /reports/{reportId}
Set Report Publish Status
Set the publish status of a report and return the new status including any enabled publish URLs via PUT /reports/{report…
Add Report Scope
Add source sheets or workspaces to a report’s scope via POST /reports/{reportId}/scope
Add Report Columns
Add columns to a report by matching source sheet columns via POST /reports/{reportId}/columns
Create Report
Create a new report via POST /reports
Delete Report
Delete a report via DELETE /reports/{reportId}
Get Report Publish Status
Retrieve the publish status of a report via GET /reports/{reportId}/publish
Remove Report Scope
Remove source sheets or workspaces from a report’s scope via DELETE /reports/{reportId}/scope
Send Report Via Email
Email a report to recipients via POST /reports/{reportId}/emails
Update Report Definition
Update a report’s definition (filters, sorting, grouping) via PUT /reports/{reportId}/definition
Get Report Path
Retrieve the path (folder hierarchy) to a report via GET /reports/{reportId}/path
Search Everything
Search for text across all accessible sheets, reports, and dashboards via GET /search, with optional scopes filtering, m…
Search Sheet
Search for text within a specific sheet identified by sheetId via GET /search/sheets/{sheetId}, returning matching rows…
List Sheet Shares (Deprecated)
(DEPRECATED) Retrieve a paginated list of sharing permissions on a sheet via GET /sheets/{sheetId}/shares, filterable by…
Share Sheet (Deprecated)
(DEPRECATED) Share a sheet with users or groups via POST /sheets/{sheetId}/shares
Delete Sheet Share
Remove a share from a sheet via DELETE /sheets/{sheetId}/shares/{shareId}
Delete Report Share
Remove a share from a report via DELETE /reports/{reportId}/shares/{shareId}
Delete Dashboard Share
Remove a share from a dashboard via DELETE /sights/{sightId}/shares/{shareId}
Delete Workspace Share
Remove a share from a workspace via DELETE /workspaces/{workspaceId}/shares/{shareId}
List Report Shares
Retrieve sharing permissions on a report via GET /reports/{reportId}/shares
List Dashboard Shares
Retrieve sharing permissions on a dashboard via GET /sights/{sightId}/shares
List Workspace Shares
Retrieve sharing permissions on a workspace via GET /workspaces/{workspaceId}/shares
Share Report
Share a report with users or groups via POST /reports/{reportId}/shares
Get Report Share
Retrieve a specific share on a report via GET /reports/{reportId}/shares/{shareId}
Get Sheet Share
Retrieve a specific share on a sheet via GET /sheets/{sheetId}/shares/{shareId}
Share Dashboard
Share a dashboard with users or groups via POST /sights/{sightId}/shares
Get Dashboard Share
Retrieve a specific share on a dashboard via GET /sights/{sightId}/shares/{shareId}
Share Workspace
Share a workspace with users or groups via POST /workspaces/{workspaceId}/shares
Get Workspace Share
Retrieve a specific share on a workspace via GET /workspaces/{workspaceId}/shares/{shareId}
Update Report Share
Update a share’s access level on a report via PUT /reports/{reportId}/shares/{shareId}
Update Sheet Share
Update a share’s access level on a sheet via PUT /sheets/{sheetId}/shares/{shareId}
Update Dashboard Share
Update a share’s access level on a dashboard via PUT /sights/{sightId}/shares/{shareId}
Update Workspace Share
Update a share’s access level on a workspace via PUT /workspaces/{workspaceId}/shares/{shareId}
List Sheets
Retrieve a paginated list of all sheets accessible to the authenticated user via GET /sheets
Create Sheet (Deprecated)
(DEPRECATED) Create a new sheet from scratch or from a template in the user’s Sheets folder (Home) via POST /sheets. The…
Get Sheet
Retrieve a full sheet including rows, columns, and cell data via GET /sheets/{sheetId}, with extensive filtering and inc…
List Columns
Retrieve all column definitions for a sheet via GET /sheets/{sheetId}/columns, including type, title, and configuration
Get Column
Retrieve a single column’s definition by ID via GET /sheets/{sheetId}/columns/{columnId}
Update Column
Update a column’s title, type, position, or configuration via PUT /sheets/{sheetId}/columns/{columnId}
Delete Column
Permanently delete a column and all its cell data from a sheet via DELETE /sheets/{sheetId}/columns/{columnId}
Add Columns
Add one or more columns to a sheet via POST /sheets/{sheetId}/columns, supporting bulk insertion in a single request
Add Rows
Add one or more rows with cell data to a sheet via POST /sheets/{sheetId}/rows, with flexible positioning control
Update Rows
Update cell values, row positions, or expand/collapse state for one or more rows via PUT /sheets/{sheetId}/rows
Delete Rows
Delete one or more rows from a sheet via DELETE /sheets/{sheetId}/rows, using comma-separated row IDs as a query paramet…
Get Row
Retrieve a specific row and its cell data from a sheet via GET /sheets/{sheetId}/rows/{rowId}
Delete Sheet
Permanently delete a sheet and all its data via DELETE /sheets/{sheetId}
Move Sheet
Move a sheet to a different folder or workspace via POST /sheets/{sheetId}/move
Import Sheet
Create a new sheet by importing data from a CSV or XLSX file via POST /sheets/import
Copy Sheet
Create a copy of a sheet to a specified folder or workspace via POST /sheets/{sheetId}/copy
Update Sheet
Update a sheet’s name, project settings, or user-level display settings via PUT /sheets/{sheetId}
Create Sheet In Workspace
Create a new sheet in a workspace via POST /workspaces/{workspaceId}/sheets, either from scratch with column definitions…
Add Summary Field
Create a summary field on a sheet via POST /sheets/{sheetId}/summary/fields
Copy Rows
Copy rows from one sheet to another via POST /sheets/{sheetId}/rows/copy
Create Sheet In Folder
Create a new sheet from scratch or template inside a folder via POST /folders/{folderId}/sheets
Delete Summary Fields
Delete one or more summary fields from a sheet via DELETE /sheets/{sheetId}/summary/fields
Get Sheet Publish Status
Retrieve the publish status of a sheet via GET /sheets/{sheetId}/publish
Get Sheet Summary
Retrieve the summary object for a sheet via GET /sheets/{sheetId}/summary
List Summary Fields
Retrieve a paginated list of summary fields for a sheet via GET /sheets/{sheetId}/summary/fields
Move Rows
Move rows from one sheet to another via POST /sheets/{sheetId}/rows/move
Send Rows Via Email
Email one or more rows from a sheet via POST /sheets/{sheetId}/rows/emails
Sort Rows
Sort rows in a sheet by one or more columns via POST /sheets/{sheetId}/sort
List Sent Update Requests
Retrieve all sent update requests on a sheet via GET /sheets/{sheetId}/sentupdaterequests
Get Sent Update Request
Retrieve a specific sent update request via GET /sheets/{sheetId}/sentupdaterequests/{sentUpdateRequestId}
Delete Sent Update Request
Delete a sent update request via DELETE /sheets/{sheetId}/sentupdaterequests/{sentUpdateRequestId}
Set Sheet Publish Status
Set the publish status of a sheet via PUT /sheets/{sheetId}/publish
Send Sheet Via Email
Email a sheet to recipients via POST /sheets/{sheetId}/emails
Update Summary Field
Update a summary field on a sheet via PUT /sheets/{sheetId}/summary/fields
List Update Requests
Retrieve all update requests on a sheet via GET /sheets/{sheetId}/updaterequests
Get Update Request
Retrieve a specific update request via GET /sheets/{sheetId}/updaterequests/{updateRequestId}
Create Update Request
Create an update request on a sheet via POST /sheets/{sheetId}/updaterequests
Update Update Request
Update an existing update request via PUT /sheets/{sheetId}/updaterequests/{updateRequestId}
Delete Update Request
Delete an update request via DELETE /sheets/{sheetId}/updaterequests/{updateRequestId}
Get Sheet Path
Retrieve the path (folder hierarchy) to a sheet via GET /sheets/{sheetId}/path
Get Sheet Version
Retrieve the current version number of a sheet via GET /sheets/{sheetId}/version
List Organization Sheets
Retrieve all sheets in the organization via GET /users/sheets (System Admin only)
List Image URLs
Get temporary download URLs for cell images via POST /imageurls
List Templates (Deprecated)
(DEPRECATED) Retrieve a paginated list of user-created templates via GET /templates. Use list_folder_children or workspa…
List Public Templates
Retrieve all public Smartsheet templates via GET /templates/public
Get Current User
Retrieve the profile of the currently authenticated user via GET /users/me, useful for verifying credentials and obtaini…
List Users
Retrieve a paginated list of all users in the Smartsheet organization via GET /users, with optional filtering by email,…
Get User
Retrieve a specific user’s profile by their numeric user ID via GET /users/{userId}
Add User
Add a new user to the Smartsheet organization via POST /users, requiring System Admin permissions
Update User
Update a user’s role assignments or profile attributes via PUT /users/{userId}, requiring System Admin permissions
Remove User
Permanently remove a user from the Smartsheet organization via DELETE /users/{userId}, with optional asset transfer
Deactivate User
Deactivate a user via POST /users/{userId}/deactivate, blocking all Smartsheet access while preserving their data and pe…
Reactivate User
Reactivate a previously deactivated user via POST /users/{userId}/reactivate, restoring full Smartsheet access
List Alternate Emails
Retrieve a user’s alternate email addresses via GET /users/{userId}/alternateemails
Add Alternate Emails
Add one or more alternate email addresses for a user via POST /users/{userId}/alternateemails (Enterprise only, requires…
Delete Alternate Email
Remove an alternate email address from a user via DELETE /users/{userId}/alternateemails/{alternateEmailId} (Enterprise…
Get Alternate Email
Retrieve a specific alternate email for a user via GET /users/{userId}/alternateemails/{alternateEmailId} (Enterprise on…
Promote Alternate Email To Primary
Promote an alternate email to primary via POST /users/{userId}/alternateemails/{alternateEmailId}/makeprimary (Enterpris…
List User Plans
Retrieve plans associated with a user via GET /users/{userId}/plans (System Admin only)
Downgrade User
Downgrade a user on a plan via POST /users/{userId}/plans/{planId}/downgrade (System Admin only)
Remove User From Plan
Remove a user from a plan via DELETE /users/{userId}/plans/{planId} (System Admin only)
Upgrade User
Upgrade a user on a plan via POST /users/{userId}/plans/{planId}/upgrade (System Admin only)
Get Server Info
Retrieve Smartsheet server information via GET /serverinfo
Revoke Access Token
Revoke the current OAuth access token via DELETE /token
List Webhooks
Retrieve a paginated list of all webhooks owned by the authenticated user via GET /webhooks
Get Webhook
Retrieve a specific webhook’s configuration and status via GET /webhooks/{webhookId}
Create Webhook
Create a new webhook subscription via POST /webhooks, targeting a specific sheet or other scoped object
Update Webhook
Update a webhook’s enabled state, event subscriptions, or custom headers via PUT /webhooks/{webhookId}. Note that scope…
Reset Webhook Shared Secret
Reset a webhook’s shared secret via POST /webhooks/{webhookId}/resetSharedSecret
Delete Webhook
Permanently delete a webhook via DELETE /webhooks/{webhookId}, immediately stopping all callbacks
List Workspaces
Retrieve a paginated list of all workspaces accessible to the authenticated user via GET /workspaces, supporting token-b…
Get Workspace
Retrieve a workspace and its contents by ID via GET /workspaces/{workspaceId} (deprecated, prefer workspace metadata and…
Create Workspace
Create a new workspace via POST /workspaces to organize sheets, reports, and dashboards
Update Workspace
Rename a workspace via PUT /workspaces/{workspaceId}
Delete Workspace
Permanently delete a workspace and all its contents via DELETE /workspaces/{workspaceId}
Copy Workspace
Duplicate a workspace and its contents via POST /workspaces/{workspaceId}/copy, with control over which elements are inc…
Create Folder In Workspace
Create a new top-level folder in a workspace via POST /workspaces/{workspaceId}/folders
List Workspace Folders
Retrieve top-level folders in a workspace via GET /workspaces/{workspaceId}/folders, with page-based pagination support…
Get Workspace Children
Retrieve child items of a workspace via GET /workspaces/{workspaceId}/children
Get Workspace Metadata
Retrieve workspace metadata via GET /workspaces/{workspaceId}/metadata

Events

|
9 events
Event
Description
Tags
Webhook Verification Challenge
Responds to Smartsheet’s webhook verification handshake by echoing the Smartsheet-Hook-Challenge value back to Smartshee…
Webhooks
Sheet Webhook Event
Processes Smartsheet callbacks where the batched events are sheet-level changes (e.g. sheet renamed).
WebhooksSheets
Row Webhook Event
Processes Smartsheet callbacks where the batched events are row changes (added, updated, or deleted rows).
WebhooksRows
Column Webhook Event
Processes Smartsheet callbacks where the batched events are column changes (added, renamed/updated, or deleted columns).
WebhooksColumns
Cell Webhook Event
Processes Smartsheet callbacks where the batched events are cell value changes.
WebhooksCells
Attachment Webhook Event
Processes Smartsheet callbacks where the batched events are attachment changes (added or deleted attachments).
WebhooksAttachments
Discussion Webhook Event
Processes Smartsheet callbacks where the batched events are discussion changes (added or deleted discussions).
WebhooksDiscussions
Comment Webhook Event
Processes Smartsheet callbacks where the batched events are comment changes within a discussion (added or deleted commen…
WebhooksComments
User Seat Type Webhook Event
Processes Smartsheet plan-scoped callbacks where the batched events are user seat type changes (e.g. a user’s license ty…
WebhooksUsers