> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Smartsheet

> How to set up the Smartsheet connector, plus the actions and events that are available.

![Smartsheet](https://stackone-logos.com/api/smartsheet/filled/svg)

Previewv1.3.0[See changelog](https://docs.stackone.com/connectors/smartsheet/changelog.md)

[203 actions](#actions) · [9 events](#events) · 2 auth methods

Project Management
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/smartsheet/guides/connector-profile/oauth-2-0.md)
>
> Requires registering an app in Smartsheet Developer Tools.

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/smartsheet/guides/connector-profile/api-key.md)
>
> 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](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/smartsheet/guides/link-account/oauth-2-0.md)

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/smartsheet/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

OAuth 2.0

No auth methods found

Scopes

Select all
|
Clear

ADMIN\_SHEETS

ADMIN\_USERS

ADMIN\_WEBHOOKS

ADMIN\_WORKSPACES

CREATE\_SHEETS

DELETE\_SHEETS

READ\_CONTACTS

READ\_EVENTS

READ\_SHEETS

READ\_USERS

SHARE\_SHEETS

WRITE\_SHEETS

No scopes found

203 actions

ActionDescriptionRequired scopes

List Attachments`smartsheet_list_attachments`

Retrieve a paginated list of all attachments on a sheet via GET /sheets/\{sheetId}/attachments

`READ_SHEETS`

Add URL Attachment To Sheet`smartsheet_add_attachment`

Attach a URL to a sheet via POST /sheets/\{sheetId}/attachments

`WRITE_SHEETS`

Get Attachment`smartsheet_get_attachment`

Retrieve a specific attachment by ID via GET /sheets/\{sheetId}/attachments/\{attachmentId}

`READ_SHEETS`

Delete Attachment`smartsheet_delete_attachment`

Delete an attachment from a sheet via DELETE /sheets/\{sheetId}/attachments/\{attachmentId}

`WRITE_SHEETS`

List Row Attachments`smartsheet_list_row_attachments`

Retrieve all attachments on a specific row via GET /sheets/\{sheetId}/rows/\{rowId}/attachments

`READ_SHEETS`

List Attachment Versions`smartsheet_list_attachment_versions`

Retrieve all versions of an attachment via GET /sheets/\{sheetId}/attachments/\{attachmentId}/versions

`READ_SHEETS`

Delete Attachment Versions`smartsheet_delete_attachment_versions`

Delete all versions of an attachment via DELETE /sheets/\{sheetId}/attachments/\{attachmentId}/versions

`WRITE_SHEETS`

List Automation Rules`smartsheet_list_automation_rules`

Retrieve all automation rules on a sheet via GET /sheets/\{sheetId}/automationrules

`READ_SHEETS`

Get Automation Rule`smartsheet_get_automation_rule`

Retrieve a specific automation rule via GET /sheets/\{sheetId}/automationrules/\{automationRuleId}

`READ_SHEETS`

Update Automation Rule`smartsheet_update_automation_rule`

Update an automation rule via PUT /sheets/\{sheetId}/automationrules/\{automationRuleId}

`ADMIN_SHEETS`

Delete Automation Rule`smartsheet_delete_automation_rule`

Delete an automation rule via DELETE /sheets/\{sheetId}/automationrules/\{automationRuleId}

`ADMIN_SHEETS`

List Contacts`smartsheet_list_contacts`

Retrieve a paginated list of the authenticated user's Smartsheet contacts via GET /contacts

`READ_CONTACTS`

Get Contact`smartsheet_get_contact`

Retrieve a specific contact's details by ID via GET /contacts/\{contactId}

`READ_CONTACTS`

List Cross-sheet References`smartsheet_list_cross_sheet_refs`

Retrieve all cross-sheet references on a sheet via GET /sheets/\{sheetId}/crosssheetreferences

`READ_SHEETS`

Create Cross-sheet Reference`smartsheet_create_cross_sheet_ref`

Create a cross-sheet reference between two sheets to define a data range for formulas via POST /sheets/\{sheetId}/crosssh...

`WRITE_SHEETS`

Get Cross-sheet Reference`smartsheet_get_cross_sheet_ref`

Retrieve a specific cross-sheet reference via GET /sheets/\{sheetId}/crosssheetreferences/\{crossSheetReferenceId}

`READ_SHEETS`

List Dashboards`smartsheet_list_dashboards`

Retrieve a paginated list of all dashboards (sights) accessible to the user via GET /sights

`READ_SHEETS`

Get Dashboard`smartsheet_get_dashboard`

Retrieve a dashboard's full configuration and widgets via GET /sights/\{sightId}

`READ_SHEETS`

Copy Dashboard`smartsheet_copy_dashboard`

Duplicate a dashboard to a destination folder or workspace via POST /sights/\{sightId}/copy

`ADMIN_SHEETS`

Delete Dashboard`smartsheet_delete_dashboard`

Delete a dashboard via DELETE /sights/\{sightId}

`DELETE_SHEETS`

Get Dashboard Publish Status`smartsheet_get_dashboard_publish`

Retrieve the publish status of a dashboard via GET /sights/\{sightId}/publish

`READ_SHEETS`

Move Dashboard`smartsheet_move_dashboard`

Move a dashboard to a different folder or workspace via POST /sights/\{sightId}/move

`ADMIN_SHEETS`

Set Dashboard Publish Status`smartsheet_set_dashboard_publish`

Set the publish status of a dashboard via PUT /sights/\{sightId}/publish

`ADMIN_SHEETS`

Update Dashboard`smartsheet_update_dashboard`

Update a dashboard's name via PUT /sights/\{sightId}

`ADMIN_SHEETS`

Get Dashboard Path`smartsheet_get_dashboard_path`

Retrieve the path (folder hierarchy) to a dashboard via GET /sights/\{sightId}/path

`READ_SHEETS`

List Discussions`smartsheet_list_discussions`

Retrieve a paginated list of all discussions on a sheet via GET /sheets/\{sheetId}/discussions

`READ_SHEETS`

Create Discussion`smartsheet_create_discussion`

Start a new discussion thread on a sheet via POST /sheets/\{sheetId}/discussions

`WRITE_SHEETS`

Get Comment`smartsheet_get_comment`

Retrieve a single comment by ID from a sheet via GET /sheets/\{sheetId}/comments/\{commentId}

`READ_SHEETS`

Edit Comment`smartsheet_edit_comment`

Update the text of a comment on a sheet via PUT /sheets/\{sheetId}/comments/\{commentId}

`WRITE_SHEETS`

Delete Comment`smartsheet_delete_comment`

Delete a comment from a sheet via DELETE /sheets/\{sheetId}/comments/\{commentId}

`WRITE_SHEETS`

Create Comment`smartsheet_create_comment`

Add a reply comment to an existing discussion thread via POST /sheets/\{sheetId}/discussions/\{discussionId}/comments

`WRITE_SHEETS`

Create Row Discussion`smartsheet_create_row_discussion`

Start a discussion on a specific row via POST /sheets/\{sheetId}/rows/\{rowId}/discussions

`WRITE_SHEETS`

List Row Discussions`smartsheet_list_row_discussions`

Retrieve all discussions on a specific row via GET /sheets/\{sheetId}/rows/\{rowId}/discussions

`READ_SHEETS`

Get Discussion`smartsheet_get_discussion`

Retrieve a specific discussion by ID via GET /sheets/\{sheetId}/discussions/\{discussionId}

`READ_SHEETS`

Delete Discussion`smartsheet_delete_discussion`

Delete a discussion and all its comments via DELETE /sheets/\{sheetId}/discussions/\{discussionId}

`WRITE_SHEETS`

List Discussion Attachments`smartsheet_list_discussion_attachments`

Retrieve attachments on a discussion via GET /sheets/\{sheetId}/discussions/\{discussionId}/attachments

`READ_SHEETS`

List Events`smartsheet_list_events`

Retrieve an audit trail of events in the organization via GET /events

`READ_EVENTS`

List Filtered Events`smartsheet_list_filtered_events`

Retrieve filtered events via POST /filteredEvents

`READ_EVENTS`

List Favorites`smartsheet_list_favorites`

Retrieve the authenticated user's favorited items via GET /favorites

`READ_SHEETS`

Add Favorite`smartsheet_add_favorite`

Add one item to the current user's favorites via POST /favorites

`READ_SHEETS`

Delete Favorites By Type`smartsheet_delete_favorites_by_type`

Remove multiple favorites of a given type via DELETE /favorites/\{favoriteType}

`READ_SHEETS`

Delete Favorite`smartsheet_delete_favorite`

Remove a single favorite by type and ID via DELETE /favorites/\{favoriteType}/\{favoriteId}

`READ_SHEETS`

Check Favorite`smartsheet_is_favorite`

Check if an item is favorited via GET /favorites/\{favoriteType}/\{favoriteId}

`READ_SHEETS`

List Personal Folders`smartsheet_list_folders`

Retrieve a paginated list of top-level personal folders from the user's Home via GET /folders/personal

`READ_SHEETS`

Get Folder (Deprecated)`smartsheet_get_folder`

(DEPRECATED, sunsetting June 2026) Retrieve a folder and its contents by ID via GET /folders/\{folderId}. Use get\_folder\_...

`READ_SHEETS`

Get Folder Metadata`smartsheet_get_folder_metadata`

Retrieve folder metadata (name, dates, permalink) via GET /folders/\{folderId}/metadata

`READ_SHEETS`

List Folder Children`smartsheet_list_folder_children`

List immediate child resources of a folder (sheets, reports, dashboards, subfolders, templates) via GET /folders/\{folder...

`READ_SHEETS`

Create Folder (Deprecated Path)`smartsheet_create_folder`

(DEPRECATED path, sunsetting June 2026) Create a new subfolder within an existing folder via POST /folders/\{folderId}/fo...

`ADMIN_WORKSPACES`

Update Folder`smartsheet_update_folder`

Rename a folder via PUT /folders/\{folderId}

`ADMIN_WORKSPACES`

Delete Folder`smartsheet_delete_folder`

Permanently delete a folder and all its contents via DELETE /folders/\{folderId}

`ADMIN_WORKSPACES`

Copy Folder`smartsheet_copy_folder`

Duplicate a folder and its contents to a destination folder or workspace via POST /folders/\{folderId}/copy

`ADMIN_WORKSPACES`

Move Folder`smartsheet_move_folder`

Move a folder to a different folder or workspace via POST /folders/\{folderId}/move

`ADMIN_WORKSPACES`

Get Folder Path`smartsheet_get_folder_path`

Retrieve the hierarchical path to a folder via GET /folders/\{folderId}/path

`READ_SHEETS`

Create Home Folder`smartsheet_create_home_folder`

Create a new top-level folder in the user's Home via POST /home/folders

`CREATE_SHEETS`

List Groups`smartsheet_list_groups`

Retrieve a paginated list of all groups in the organization via GET /groups, useful for auditing group membership and ma...

`READ_USERS`

Get Group`smartsheet_get_group`

Retrieve a specific group and its full member list via GET /groups/\{groupId}

`READ_USERS`

Create Group`smartsheet_create_group`

Create a new group in the organization via POST /groups, optionally seeding it with initial members by email

`ADMIN_USERS`

Update Group`smartsheet_update_group`

Update a group's name, description, or transfer ownership via PUT /groups/\{groupId}

`ADMIN_USERS`

Add Group Members`smartsheet_add_group_members`

Add one or more members to an existing group via POST /groups/\{groupId}/members

`ADMIN_USERS`

Delete Group Member`smartsheet_delete_group_member`

Remove a specific member from a group via DELETE /groups/\{groupId}/members/\{userId}

`ADMIN_USERS`

Delete Group`smartsheet_delete_group`

Permanently delete a group from the organization via DELETE /groups/\{groupId}

`ADMIN_USERS`

Get Unified Credentials`smartsheet_unified_get_me`

Get the current Smartsheet connection's unified credentials and identity.

`READ_USERS`

IAM Auth Test`smartsheet_auth_test`

Validate the current Smartsheet credentials and return the raw, unmapped /users/me JSON. Bypasses the unified IAM creden...

`READ_USERS`

List Unified Groups`smartsheet_unified_list_groups`

List unified groups in Smartsheet.

`READ_USERS`

Get Unified Group`smartsheet_unified_get_group`

Get a unified Smartsheet group by ID.

`READ_USERS`

List Unified Organizations`smartsheet_unified_list_organizations`

List unified organizations in Smartsheet.

`READ_USERS`

Get Unified Organization`smartsheet_unified_get_organization`

Get a unified Smartsheet organization by ID.

`READ_USERS`

List Unified Resource Types`smartsheet_unified_list_resource_types`

List unified resource types in Smartsheet.

`READ_USERS`

List Unified Resource Users`smartsheet_unified_list_resource_users`

List unified resource users in Smartsheet for a given workspace or sheet.

List Unified Roles`smartsheet_unified_list_roles`

List unified roles in Smartsheet.

`READ_USERS`

Get Unified Role`smartsheet_unified_get_role`

Get a unified Smartsheet role by ID.

`READ_USERS`

List Unified Users`smartsheet_unified_list_users`

List unified users in Smartsheet.

`READ_USERS`

Get Unified User`smartsheet_unified_get_user`

Get a unified Smartsheet user by ID.

`READ_USERS`

Update Unified User`smartsheet_unified_update_user`

Update a unified Smartsheet user by ID.

`ADMIN_USERS`

Delete Unified User`smartsheet_unified_delete_user`

Delete a unified Smartsheet user by ID.

`ADMIN_USERS`

List Proofs`smartsheet_list_proofs`

Retrieve all proofs on a sheet via GET /sheets/\{sheetId}/proofs

`READ_SHEETS`

Create Proof`smartsheet_create_proof`

Create a new proof on a row via POST /sheets/\{sheetId}/rows/\{rowId}/proofs

`WRITE_SHEETS`

Update Proof`smartsheet_update_proof`

Update a proof on a sheet via PUT /sheets/\{sheetId}/proofs/\{proofId}

`WRITE_SHEETS`

Delete Proof`smartsheet_delete_proof`

Delete a proof from a sheet via DELETE /sheets/\{sheetId}/proofs/\{proofId}

`WRITE_SHEETS`

Create Proof Discussion`smartsheet_create_proof_discussion`

Start a discussion on a proof via POST /sheets/\{sheetId}/proofs/\{proofId}/discussions

`WRITE_SHEETS`

Create Proof Requests`smartsheet_create_proof_requests`

Send proof requests (review invitations) via POST /sheets/\{sheetId}/proofs/\{proofId}/requests

`WRITE_SHEETS`

Delete Proof Requests`smartsheet_delete_proof_requests`

Delete proof requests from a proof via DELETE /sheets/\{sheetId}/proofs/\{proofId}/requests

`WRITE_SHEETS`

Create Proof Version`smartsheet_create_proof_version`

Create a new version of a proof via POST /sheets/\{sheetId}/proofs/\{proofId}/versions

`WRITE_SHEETS`

Delete Proof Version`smartsheet_delete_proof_version`

Delete a proof version via DELETE /sheets/\{sheetId}/proofs/\{proofId}/versions

`WRITE_SHEETS`

Get Proof`smartsheet_get_proof`

Retrieve a specific proof by ID via GET /sheets/\{sheetId}/proofs/\{proofId}

`READ_SHEETS`

List Proof Versions`smartsheet_list_proof_versions`

Retrieve all versions of a proof via GET /sheets/\{sheetId}/proofs/\{proofId}/versions

`READ_SHEETS`

List Proof Attachments`smartsheet_list_proof_attachments`

Retrieve attachments on a proof via GET /sheets/\{sheetId}/proofs/\{proofId}/attachments

`READ_SHEETS`

List Proof Discussions`smartsheet_list_proof_discussions`

Retrieve discussions on a proof via GET /sheets/\{sheetId}/proofs/\{proofId}/discussions

`READ_SHEETS`

List Proof Request Actions`smartsheet_list_proof_request_actions`

Retrieve request actions on a proof via GET /sheets/\{sheetId}/proofs/\{proofId}/requestactions

`READ_SHEETS`

List Reports`smartsheet_list_reports`

Retrieve a paginated list of all reports accessible to the user via GET /reports

`READ_SHEETS`

Get Report`smartsheet_get_report`

Retrieve a report's data and configuration via GET /reports/\{reportId}

`READ_SHEETS`

Set Report Publish Status`smartsheet_set_report_publish`

Set the publish status of a report and return the new status including any enabled publish URLs via PUT /reports/\{report...

`ADMIN_SHEETS`

Add Report Scope`smartsheet_add_report_scope`

Add source sheets or workspaces to a report's scope via POST /reports/\{reportId}/scope

`ADMIN_SHEETS`

Add Report Columns`smartsheet_add_report_columns`

Add columns to a report by matching source sheet columns via POST /reports/\{reportId}/columns

`ADMIN_SHEETS`

Create Report`smartsheet_create_report`

Create a new report via POST /reports

`CREATE_SHEETS`

Delete Report`smartsheet_delete_report`

Delete a report via DELETE /reports/\{reportId}

`DELETE_SHEETS`

Get Report Publish Status`smartsheet_get_report_publish`

Retrieve the publish status of a report via GET /reports/\{reportId}/publish

`READ_SHEETS`

Remove Report Scope`smartsheet_remove_report_scope`

Remove source sheets or workspaces from a report's scope via DELETE /reports/\{reportId}/scope

`ADMIN_SHEETS`

Send Report Via Email`smartsheet_send_report_via_email`

Email a report to recipients via POST /reports/\{reportId}/emails

`SHARE_SHEETS`

Update Report Definition`smartsheet_update_report_definition`

Update a report's definition (filters, sorting, grouping) via PUT /reports/\{reportId}/definition

`ADMIN_SHEETS`

Get Report Path`smartsheet_get_report_path`

Retrieve the path (folder hierarchy) to a report via GET /reports/\{reportId}/path

`READ_SHEETS`

Search Everything`smartsheet_search_everything`

Search for text across all accessible sheets, reports, and dashboards via GET /search, with optional scopes filtering, m...

`READ_SHEETS`

Search Sheet`smartsheet_search_sheet`

Search for text within a specific sheet identified by sheetId via GET /search/sheets/\{sheetId}, returning matching rows...

`READ_SHEETS`

List Sheet Shares (Deprecated)`smartsheet_list_sheet_shares`

(DEPRECATED) Retrieve a paginated list of sharing permissions on a sheet via GET /sheets/\{sheetId}/shares, filterable by...

`SHARE_SHEETS`

Share Sheet (Deprecated)`smartsheet_share_sheet`

(DEPRECATED) Share a sheet with users or groups via POST /sheets/\{sheetId}/shares

`SHARE_SHEETS`

Delete Sheet Share`smartsheet_delete_sheet_share`

Remove a share from a sheet via DELETE /sheets/\{sheetId}/shares/\{shareId}

`SHARE_SHEETS`

Delete Report Share`smartsheet_delete_report_share`

Remove a share from a report via DELETE /reports/\{reportId}/shares/\{shareId}

`SHARE_SHEETS`

Delete Dashboard Share`smartsheet_delete_dashboard_share`

Remove a share from a dashboard via DELETE /sights/\{sightId}/shares/\{shareId}

`SHARE_SHEETS`

Delete Workspace Share`smartsheet_delete_workspace_share`

Remove a share from a workspace via DELETE /workspaces/\{workspaceId}/shares/\{shareId}

`ADMIN_WORKSPACES`

List Report Shares`smartsheet_list_report_shares`

Retrieve sharing permissions on a report via GET /reports/\{reportId}/shares

`SHARE_SHEETS`

List Dashboard Shares`smartsheet_list_dashboard_shares`

Retrieve sharing permissions on a dashboard via GET /sights/\{sightId}/shares

`SHARE_SHEETS`

List Workspace Shares`smartsheet_list_workspace_shares`

Retrieve sharing permissions on a workspace via GET /workspaces/\{workspaceId}/shares

`ADMIN_WORKSPACES`

Share Report`smartsheet_share_report`

Share a report with users or groups via POST /reports/\{reportId}/shares

`SHARE_SHEETS`

Get Report Share`smartsheet_get_report_share`

Retrieve a specific share on a report via GET /reports/\{reportId}/shares/\{shareId}

`SHARE_SHEETS`

Get Sheet Share`smartsheet_get_sheet_share`

Retrieve a specific share on a sheet via GET /sheets/\{sheetId}/shares/\{shareId}

`SHARE_SHEETS`

Share Dashboard`smartsheet_share_dashboard`

Share a dashboard with users or groups via POST /sights/\{sightId}/shares

`SHARE_SHEETS`

Get Dashboard Share`smartsheet_get_dashboard_share`

Retrieve a specific share on a dashboard via GET /sights/\{sightId}/shares/\{shareId}

`SHARE_SHEETS`

Share Workspace`smartsheet_share_workspace`

Share a workspace with users or groups via POST /workspaces/\{workspaceId}/shares

`ADMIN_WORKSPACES`

Get Workspace Share`smartsheet_get_workspace_share`

Retrieve a specific share on a workspace via GET /workspaces/\{workspaceId}/shares/\{shareId}

`ADMIN_WORKSPACES`

Update Report Share`smartsheet_update_report_share`

Update a share's access level on a report via PUT /reports/\{reportId}/shares/\{shareId}

`SHARE_SHEETS`

Update Sheet Share`smartsheet_update_sheet_share`

Update a share's access level on a sheet via PUT /sheets/\{sheetId}/shares/\{shareId}

`SHARE_SHEETS`

Update Dashboard Share`smartsheet_update_dashboard_share`

Update a share's access level on a dashboard via PUT /sights/\{sightId}/shares/\{shareId}

`SHARE_SHEETS`

Update Workspace Share`smartsheet_update_workspace_share`

Update a share's access level on a workspace via PUT /workspaces/\{workspaceId}/shares/\{shareId}

`ADMIN_WORKSPACES`

List Sheets`smartsheet_list_sheets`

Retrieve a paginated list of all sheets accessible to the authenticated user via GET /sheets

`READ_SHEETS`

Create Sheet (Deprecated)`smartsheet_create_sheet`

(DEPRECATED) Create a new sheet from scratch or from a template in the user's Sheets folder (Home) via POST /sheets. The...

`CREATE_SHEETS`

Get Sheet`smartsheet_get_sheet`

Retrieve a full sheet including rows, columns, and cell data via GET /sheets/\{sheetId}, with extensive filtering and inc...

`READ_SHEETS`

List Columns`smartsheet_list_columns`

Retrieve all column definitions for a sheet via GET /sheets/\{sheetId}/columns, including type, title, and configuration

`READ_SHEETS`

Get Column`smartsheet_get_column`

Retrieve a single column's definition by ID via GET /sheets/\{sheetId}/columns/\{columnId}

`READ_SHEETS`

Update Column`smartsheet_update_column`

Update a column's title, type, position, or configuration via PUT /sheets/\{sheetId}/columns/\{columnId}

`ADMIN_SHEETS`

Delete Column`smartsheet_delete_column`

Permanently delete a column and all its cell data from a sheet via DELETE /sheets/\{sheetId}/columns/\{columnId}

`ADMIN_SHEETS`

Add Columns`smartsheet_add_columns`

Add one or more columns to a sheet via POST /sheets/\{sheetId}/columns, supporting bulk insertion in a single request

`ADMIN_SHEETS`

Add Rows`smartsheet_add_rows`

Add one or more rows with cell data to a sheet via POST /sheets/\{sheetId}/rows, with flexible positioning control

`WRITE_SHEETS`

Update Rows`smartsheet_update_rows`

Update cell values, row positions, or expand/collapse state for one or more rows via PUT /sheets/\{sheetId}/rows

`WRITE_SHEETS`

Delete Rows`smartsheet_delete_rows`

Delete one or more rows from a sheet via DELETE /sheets/\{sheetId}/rows, using comma-separated row IDs as a query paramet...

`WRITE_SHEETS`

Get Row`smartsheet_get_row`

Retrieve a specific row and its cell data from a sheet via GET /sheets/\{sheetId}/rows/\{rowId}

`READ_SHEETS`

Delete Sheet`smartsheet_delete_sheet`

Permanently delete a sheet and all its data via DELETE /sheets/\{sheetId}

`DELETE_SHEETS`

Move Sheet`smartsheet_move_sheet`

Move a sheet to a different folder or workspace via POST /sheets/\{sheetId}/move

`ADMIN_SHEETS`

Import Sheet`smartsheet_import_sheet`

Create a new sheet by importing data from a CSV or XLSX file via POST /sheets/import

`CREATE_SHEETS`

Copy Sheet`smartsheet_copy_sheet`

Create a copy of a sheet to a specified folder or workspace via POST /sheets/\{sheetId}/copy

`CREATE_SHEETS`

Update Sheet`smartsheet_update_sheet`

Update a sheet's name, project settings, or user-level display settings via PUT /sheets/\{sheetId}

`ADMIN_SHEETS`

Create Sheet In Workspace`smartsheet_create_sheet_in_workspace`

Create a new sheet in a workspace via POST /workspaces/\{workspaceId}/sheets, either from scratch with column definitions...

`CREATE_SHEETS`

Add Summary Field`smartsheet_add_summary_fields`

Create a summary field on a sheet via POST /sheets/\{sheetId}/summary/fields

`ADMIN_SHEETS`

Copy Rows`smartsheet_copy_rows`

Copy rows from one sheet to another via POST /sheets/\{sheetId}/rows/copy

`WRITE_SHEETS`

Create Sheet In Folder`smartsheet_create_sheet_in_folder`

Create a new sheet from scratch or template inside a folder via POST /folders/\{folderId}/sheets

`CREATE_SHEETS`

Delete Summary Fields`smartsheet_delete_summary_fields`

Delete one or more summary fields from a sheet via DELETE /sheets/\{sheetId}/summary/fields

`ADMIN_SHEETS`

Get Sheet Publish Status`smartsheet_get_sheet_publish`

Retrieve the publish status of a sheet via GET /sheets/\{sheetId}/publish

`READ_SHEETS`

Get Sheet Summary`smartsheet_list_summary`

Retrieve the summary object for a sheet via GET /sheets/\{sheetId}/summary

`READ_SHEETS`

List Summary Fields`smartsheet_list_summary_fields`

Retrieve a paginated list of summary fields for a sheet via GET /sheets/\{sheetId}/summary/fields

`READ_SHEETS`

Move Rows`smartsheet_move_rows`

Move rows from one sheet to another via POST /sheets/\{sheetId}/rows/move

`WRITE_SHEETS`

Send Rows Via Email`smartsheet_send_rows_via_email`

Email one or more rows from a sheet via POST /sheets/\{sheetId}/rows/emails

`SHARE_SHEETS`

Sort Rows`smartsheet_sort_rows`

Sort rows in a sheet by one or more columns via POST /sheets/\{sheetId}/sort

`WRITE_SHEETS`

List Sent Update Requests`smartsheet_list_sent_update_requests`

Retrieve all sent update requests on a sheet via GET /sheets/\{sheetId}/sentupdaterequests

`WRITE_SHEETS`

Get Sent Update Request`smartsheet_get_sent_update_request`

Retrieve a specific sent update request via GET /sheets/\{sheetId}/sentupdaterequests/\{sentUpdateRequestId}

`WRITE_SHEETS`

Delete Sent Update Request`smartsheet_delete_sent_update_request`

Delete a sent update request via DELETE /sheets/\{sheetId}/sentupdaterequests/\{sentUpdateRequestId}

`WRITE_SHEETS`

Set Sheet Publish Status`smartsheet_set_sheet_publish`

Set the publish status of a sheet via PUT /sheets/\{sheetId}/publish

`ADMIN_SHEETS`

Send Sheet Via Email`smartsheet_send_sheet_via_email`

Email a sheet to recipients via POST /sheets/\{sheetId}/emails

`SHARE_SHEETS`

Update Summary Field`smartsheet_update_summary_fields`

Update a summary field on a sheet via PUT /sheets/\{sheetId}/summary/fields

`ADMIN_SHEETS`

List Update Requests`smartsheet_list_update_requests`

Retrieve all update requests on a sheet via GET /sheets/\{sheetId}/updaterequests

`WRITE_SHEETS`

Get Update Request`smartsheet_get_update_request`

Retrieve a specific update request via GET /sheets/\{sheetId}/updaterequests/\{updateRequestId}

`WRITE_SHEETS`

Create Update Request`smartsheet_create_update_request`

Create an update request on a sheet via POST /sheets/\{sheetId}/updaterequests

`WRITE_SHEETS`

Update Update Request`smartsheet_update_update_request`

Update an existing update request via PUT /sheets/\{sheetId}/updaterequests/\{updateRequestId}

`WRITE_SHEETS`

Delete Update Request`smartsheet_delete_update_request`

Delete an update request via DELETE /sheets/\{sheetId}/updaterequests/\{updateRequestId}

`WRITE_SHEETS`

Get Sheet Path`smartsheet_get_sheet_path`

Retrieve the path (folder hierarchy) to a sheet via GET /sheets/\{sheetId}/path

`READ_SHEETS`

Get Sheet Version`smartsheet_get_sheet_version`

Retrieve the current version number of a sheet via GET /sheets/\{sheetId}/version

`READ_SHEETS`

List Organization Sheets`smartsheet_list_org_sheets`

Retrieve all sheets in the organization via GET /users/sheets (System Admin only)

`READ_SHEETS`

List Image URLs`smartsheet_list_image_urls`

Get temporary download URLs for cell images via POST /imageurls

`READ_SHEETS`

List Templates (Deprecated)`smartsheet_list_templates`

(DEPRECATED) Retrieve a paginated list of user-created templates via GET /templates. Use list\_folder\_children or workspa...

`READ_SHEETS`

List Public Templates`smartsheet_list_public_templates`

Retrieve all public Smartsheet templates via GET /templates/public

`READ_SHEETS`

Get Current User`smartsheet_get_current_user`

Retrieve the profile of the currently authenticated user via GET /users/me, useful for verifying credentials and obtaini...

`READ_USERS`

List Users`smartsheet_list_users`

Retrieve a paginated list of all users in the Smartsheet organization via GET /users, with optional filtering by email,...

`READ_USERS`

Get User`smartsheet_get_user`

Retrieve a specific user's profile by their numeric user ID via GET /users/\{userId}

`READ_USERS`

Add User`smartsheet_add_user`

Add a new user to the Smartsheet organization via POST /users, requiring System Admin permissions

`ADMIN_USERS`

Update User`smartsheet_update_user`

Update a user's role assignments or profile attributes via PUT /users/\{userId}, requiring System Admin permissions

`ADMIN_USERS`

Remove User`smartsheet_remove_user`

Permanently remove a user from the Smartsheet organization via DELETE /users/\{userId}, with optional asset transfer

`ADMIN_USERS`

Deactivate User`smartsheet_deactivate_user`

Deactivate a user via POST /users/\{userId}/deactivate, blocking all Smartsheet access while preserving their data and pe...

`ADMIN_USERS`

Reactivate User`smartsheet_reactivate_user`

Reactivate a previously deactivated user via POST /users/\{userId}/reactivate, restoring full Smartsheet access

`ADMIN_USERS`

List Alternate Emails`smartsheet_list_alternate_emails`

Retrieve a user's alternate email addresses via GET /users/\{userId}/alternateemails

`ADMIN_USERS`

Add Alternate Emails`smartsheet_add_alternate_emails`

Add one or more alternate email addresses for a user via POST /users/\{userId}/alternateemails (Enterprise only, requires...

`ADMIN_USERS`

Delete Alternate Email`smartsheet_delete_alternate_email`

Remove an alternate email address from a user via DELETE /users/\{userId}/alternateemails/\{alternateEmailId} (Enterprise...

`ADMIN_USERS`

Get Alternate Email`smartsheet_get_alternate_email`

Retrieve a specific alternate email for a user via GET /users/\{userId}/alternateemails/\{alternateEmailId} (Enterprise on...

`ADMIN_USERS`

Promote Alternate Email To Primary`smartsheet_promote_alternate_email`

Promote an alternate email to primary via POST /users/\{userId}/alternateemails/\{alternateEmailId}/makeprimary (Enterpris...

`ADMIN_USERS`

List User Plans`smartsheet_list_user_plans`

Retrieve plans associated with a user via GET /users/\{userId}/plans (System Admin only)

`ADMIN_USERS`

Downgrade User`smartsheet_downgrade_user`

Downgrade a user on a plan via POST /users/\{userId}/plans/\{planId}/downgrade (System Admin only)

`ADMIN_USERS`

Remove User From Plan`smartsheet_remove_user_from_plan`

Remove a user from a plan via DELETE /users/\{userId}/plans/\{planId} (System Admin only)

`ADMIN_USERS`

Upgrade User`smartsheet_upgrade_user`

Upgrade a user on a plan via POST /users/\{userId}/plans/\{planId}/upgrade (System Admin only)

`ADMIN_USERS`

Get Server Info`smartsheet_get_server_info`

Retrieve Smartsheet server information via GET /serverinfo

Revoke Access Token`smartsheet_delete_token`

Revoke the current OAuth access token via DELETE /token

List Webhooks`smartsheet_list_webhooks`

Retrieve a paginated list of all webhooks owned by the authenticated user via GET /webhooks

`ADMIN_WEBHOOKS`

Get Webhook`smartsheet_get_webhook`

Retrieve a specific webhook's configuration and status via GET /webhooks/\{webhookId}

`ADMIN_WEBHOOKS`

Create Webhook`smartsheet_create_webhook`

Create a new webhook subscription via POST /webhooks, targeting a specific sheet or other scoped object

`ADMIN_WEBHOOKS`

Update Webhook`smartsheet_update_webhook`

Update a webhook's enabled state, event subscriptions, or custom headers via PUT /webhooks/\{webhookId}. Note that scope...

`ADMIN_WEBHOOKS`

Reset Webhook Shared Secret`smartsheet_reset_webhook_secret`

Reset a webhook's shared secret via POST /webhooks/\{webhookId}/resetSharedSecret

`ADMIN_WEBHOOKS`

Delete Webhook`smartsheet_delete_webhook`

Permanently delete a webhook via DELETE /webhooks/\{webhookId}, immediately stopping all callbacks

`ADMIN_WEBHOOKS`

List Workspaces`smartsheet_list_workspaces`

Retrieve a paginated list of all workspaces accessible to the authenticated user via GET /workspaces, supporting token-b...

`READ_SHEETS`

Get Workspace`smartsheet_get_workspace`

Retrieve a workspace and its contents by ID via GET /workspaces/\{workspaceId} (deprecated, prefer workspace metadata and...

`READ_SHEETS`

Create Workspace`smartsheet_create_workspace`

Create a new workspace via POST /workspaces to organize sheets, reports, and dashboards

`ADMIN_WORKSPACES`

Update Workspace`smartsheet_update_workspace`

Rename a workspace via PUT /workspaces/\{workspaceId}

`ADMIN_WORKSPACES`

Delete Workspace`smartsheet_delete_workspace`

Permanently delete a workspace and all its contents via DELETE /workspaces/\{workspaceId}

`ADMIN_WORKSPACES`

Copy Workspace`smartsheet_copy_workspace`

Duplicate a workspace and its contents via POST /workspaces/\{workspaceId}/copy, with control over which elements are inc...

`ADMIN_WORKSPACES`

Create Folder In Workspace`smartsheet_create_folder_in_workspace`

Create a new top-level folder in a workspace via POST /workspaces/\{workspaceId}/folders

`ADMIN_WORKSPACES`

List Workspace Folders`smartsheet_list_workspace_folders`

Retrieve top-level folders in a workspace via GET /workspaces/\{workspaceId}/folders, with page-based pagination support...

`READ_SHEETS`

Get Workspace Children`smartsheet_get_workspace_children`

Retrieve child items of a workspace via GET /workspaces/\{workspaceId}/children

`READ_SHEETS`

Get Workspace Metadata`smartsheet_get_workspace_metadata`

Retrieve workspace metadata via GET /workspaces/\{workspaceId}/metadata

`READ_SHEETS`

## Events

Tags

Select all
|
Clear

Attachments

Cells

Columns

Comments

Discussions

Rows

Sheets

Users

Webhooks

No tags found

9 events

EventDescriptionTags

Webhook Verification Challenge`smartsheet_webhook_verify_challenge`

Responds to Smartsheet's webhook verification handshake by echoing the Smartsheet-Hook-Challenge value back to Smartshee...

Webhooks

Sheet Webhook Event`smartsheet_webhook_sheet_event`

Processes Smartsheet callbacks where the batched events are sheet-level changes (e.g. sheet renamed).

WebhooksSheets

Row Webhook Event`smartsheet_webhook_row_event`

Processes Smartsheet callbacks where the batched events are row changes (added, updated, or deleted rows).

WebhooksRows

Column Webhook Event`smartsheet_webhook_column_event`

Processes Smartsheet callbacks where the batched events are column changes (added, renamed/updated, or deleted columns).

WebhooksColumns

Cell Webhook Event`smartsheet_webhook_cell_event`

Processes Smartsheet callbacks where the batched events are cell value changes.

WebhooksCells

Attachment Webhook Event`smartsheet_webhook_attachment_event`

Processes Smartsheet callbacks where the batched events are attachment changes (added or deleted attachments).

WebhooksAttachments

Discussion Webhook Event`smartsheet_webhook_discussion_event`

Processes Smartsheet callbacks where the batched events are discussion changes (added or deleted discussions).

WebhooksDiscussions

Comment Webhook Event`smartsheet_webhook_comment_event`

Processes Smartsheet callbacks where the batched events are comment changes within a discussion (added or deleted commen...

WebhooksComments

User Seat Type Webhook Event`smartsheet_webhook_user_seattype_event`

Processes Smartsheet plan-scoped callbacks where the batched events are user seat type changes (e.g. a user's license ty...

WebhooksUsers


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.