--- canonical_url: "https://docs.composio.dev/toolkits/smartsheet" markdown_url: "https://docs.composio.dev/toolkits/smartsheet.md" product: "platform" version: null last_updated: null --- # Smartsheet Smartsheet is a collaborative work management platform for organizing projects, sheets, reports, dashboards, workflows, and teams. - **Category:** project management - **Auth:** OAUTH2, BEARER_TOKEN - **Composio-managed OAuth available?** No - **Tools:** 185 - **Triggers:** 0 - **Slug:** `SMARTSHEET` - **Version:** 00000000_00 ## Tools ### Add Alternate Emails **Slug:** `SMARTSHEET_ADD_ALTERNATE_EMAILS` Add one or more alternate email addresses for a user. Available only to System Admins on Enterprise plans with the feature activated by Support. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | No | One alternate email object or an array of alternate email objects. | | `user_id` | integer | Yes | ID of the user receiving the alternate emails. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Attachment Version **Slug:** `SMARTSHEET_ADD_ATTACHMENT_VERSION` Upload a new binary or multipart version of an existing sheet or row file attachment. Files are limited to 30 MB; attachment uploads cost 10 rate-limit units. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | Yes | New attachment version to upload. Smartsheet limits files to 30 MB. | | `sheet_id` | integer | Yes | ID of the sheet being accessed. | | `upload_mode` | string ("application/octet-stream" | "multipart/form-data") | Yes | Request media type for the new file version. | | `attachment_id` | string | Yes | ID of the attachment receiving a new version. | | `multipart_fields` | object | No | Optional non-file fields used only with multipart/form-data mode; the file is sent in the file part. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Cell Image **Slug:** `SMARTSHEET_ADD_CELL_IMAGE` Upload image bytes to a specific Smartsheet cell using the binary file marker contract. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | Yes | Image file whose bytes are uploaded directly to the cell. | | `row_id` | string | Yes | ID of the row containing the cell. | | `alt_text` | string | No | Alternate text for the image. | | `sheet_id` | string | Yes | ID of the sheet containing the cell. | | `column_id` | string | Yes | ID of the column containing the cell. | | `upload_mode` | string | No | Binary request media type used for the image upload. | | `override_validation` | boolean | No | Allow the image despite cell validation limits. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Columns **Slug:** `SMARTSHEET_ADD_COLUMNS` Inserts one or more columns into a sheet. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | No | One column or an array of columns to create. Multiple columns must use the same index. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Favorites **Slug:** `SMARTSHEET_ADD_FAVORITES` Adds one or more items to the user's Smartsheet favorites. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | One favorite or a list of favorites to add. | | `x_smar_sc_actor_id` | string | No | ID of the user on whose behalf the request is made. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Group **Slug:** `SMARTSHEET_ADD_GROUP` Creates a new organization group. Requires group administrator or system administrator access. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Group to create. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Group Members **Slug:** `SMARTSHEET_ADD_GROUP_MEMBERS` Adds one or more members to a group asynchronously. Requires group administrator or system administrator access. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | No | One member or an array of members to add. Use primary email addresses. | | `group_id` | string | Yes | ID of the group to add members to. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Report Columns **Slug:** `SMARTSHEET_ADD_REPORT_COLUMNS` Add columns to a report. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | array | No | Report columns to add, at most 400. | | `report_id` | string | Yes | ID of the report. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Report Scope **Slug:** `SMARTSHEET_ADD_REPORT_SCOPE` Add source sheets to a report by sheet or parent workspace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | array | No | Sheets or workspaces to add, at most 100. | | `report_id` | string | Yes | ID of the report. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Rows **Slug:** `SMARTSHEET_ADD_ROWS` Insert one row or a batch of up to 500 rows, preserving Smartsheet location specifiers for top, bottom, parent, and sibling placement. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | No | One row or an array of up to 500 rows. All rows in a batch must use the same location specifiers. | | `sheet_id` | string | Yes | ID of the sheet receiving the rows. | | `access_api_level` | string | No | Access API level; use 1 to permit COMMENTER semantics. | | `override_validation` | boolean | No | Allow values outside column validation limits. | | `allow_partial_success` | boolean | No | Allow valid rows to succeed when others fail. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Summary Field Image **Slug:** `SMARTSHEET_ADD_SUMMARY_FIELD_IMAGE` Uploads raw image bytes to a sheet summary field. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | Yes | Image file whose bytes are sent as the request body. | | `alt_text` | string | No | Alternate text for the image. | | `field_id` | string | Yes | ID of the sheet summary field being accessed. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `upload_mode` | string | No | Request media type; this operation uses a raw binary body. | | `override_validation` | boolean | No | Allow a value outside field validation limits. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Summary Fields **Slug:** `SMARTSHEET_ADD_SUMMARY_FIELDS` Creates one or more summary fields on a sheet. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | array | Yes | Summary fields to create. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `rename_if_conflict` | boolean | No | Rename duplicate field titles to make them unique. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add User **Slug:** `SMARTSHEET_ADD_USER` Add a user to the organization account. Requires a qualifying paid plan and System Admin permission. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | User attributes to create. | | `send_email` | boolean | No | Notify the new user by email. At most 1000 emails may be sent. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Attach To Comment **Slug:** `SMARTSHEET_ATTACH_TO_COMMENT` Attach a file or supported provider URL to a comment. Files are limited to 30 MB; uploads cost 10 rate-limit units and are limited to 30 calls per minute per token. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | No | File to upload in binary or multipart mode. Smartsheet limits files to 30 MB. | | `sheet_id` | integer | Yes | ID of the sheet being accessed. | | `json_body` | object | No | URL attachment request used only with application/json mode. | | `comment_id` | string | Yes | ID of the comment receiving the attachment. | | `upload_mode` | string ("application/octet-stream" | "multipart/form-data" | "application/json") | Yes | Request media type. Choose binary or multipart for a file, or JSON for a URL attachment. | | `multipart_fields` | object | No | Optional non-file fields used only with multipart/form-data mode; the file is sent in the file part. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Attach To Proof **Slug:** `SMARTSHEET_ATTACH_TO_PROOF` Attaches a file of up to 30 MB to a proof. Uploads cost 10 rate-limit units and are limited to 30 calls per minute per token. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | Yes | File to attach to the proof. Smartsheet limits the file to 30 MB. | | `proof_id` | string | Yes | ID of the original proof. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `upload_mode` | string | No | Request media type; this operation accepts application/octet-stream only. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Attach To Row **Slug:** `SMARTSHEET_ATTACH_TO_ROW` Attach a file or supported provider URL to a row. Files are limited to 30 MB; uploads cost 10 rate-limit units and are limited to 30 calls per minute per token. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | No | File to upload in binary or multipart mode. Smartsheet limits files to 30 MB. | | `row_id` | integer | Yes | ID of the row receiving the attachment. | | `sheet_id` | integer | Yes | ID of the sheet being accessed. | | `json_body` | object | No | URL attachment request used only with application/json mode. | | `upload_mode` | string ("application/octet-stream" | "multipart/form-data" | "application/json") | Yes | Request media type. Choose binary or multipart for a file, or JSON for a URL attachment. | | `multipart_fields` | object | No | Optional non-file fields used only with multipart/form-data mode; the file is sent in the file part. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Attach To Sheet **Slug:** `SMARTSHEET_ATTACH_TO_SHEET` Attach a file or supported provider URL to a sheet. Files are limited to 30 MB; uploads cost 10 rate-limit units and are limited to 30 calls per minute per token. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | No | File to upload in binary or multipart mode. Smartsheet limits files to 30 MB. | | `sheet_id` | integer | Yes | ID of the sheet receiving the attachment. | | `json_body` | object | No | URL attachment request used only with application/json mode. | | `upload_mode` | string ("application/octet-stream" | "multipart/form-data" | "application/json") | Yes | Request media type. Choose binary or multipart for a file, or JSON for a URL attachment. | | `multipart_fields` | object | No | Optional non-file fields used only with multipart/form-data mode; the file is sent in the file part. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Check Favorite **Slug:** `SMARTSHEET_CHECK_FAVORITE` Checks whether a specific Smartsheet item is a favorite. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include` | string ("directId" | "name") | No | Optional favorite detail to include. | | `favorite_id` | string | Yes | ID of the item to check. | | `favorite_type` | string ("folder" | "report" | "sheet" | "sight" | "template" | "workspace") | Yes | Favorite type. | | `x_smar_sc_actor_id` | string | No | ID of the user on whose behalf the request is made. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Copy Dashboard **Slug:** `SMARTSHEET_COPY_DASHBOARD` Creates a copy of a specified Smartsheet dashboard. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Destination and optional new name for the copy. | | `sight_id` | string | Yes | ID of the dashboard to copy. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Copy Folder **Slug:** `SMARTSHEET_COPY_FOLDER` Copies a Smartsheet folder. Cell history is not copied. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | New folder destination specification. | | `exclude` | string | No | Set to sheetHyperlinks to exclude sheet hyperlinks. | | `include` | array | No | Comma-separated element categories to copy. | | `folder_id` | string | Yes | ID of the folder to copy. | | `skip_remap` | array | No | Comma-separated references not to remap in the copied folder. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Copy Rows To Another Sheet **Slug:** `SMARTSHEET_COPY_ROWS_TO_ANOTHER_SHEET` Copy selected rows to the bottom of another Smartsheet sheet. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Source row IDs and destination sheet. | | `include` | string ("all" | "attachments" | "children" | "discussions") | No | Additional row elements to copy. | | `sheet_id` | string | Yes | ID of the source sheet. | | `ignore_rows_not_found` | boolean | No | Ignore source row IDs that do not exist. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Copy Sheet **Slug:** `SMARTSHEET_COPY_SHEET` Creates a copy of the specified sheet. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Destination where to create a copy of the specified sheet. | | `exclude` | string | No | When specified with a value of **sheetHyperlinks**, excludes this category from the response | | `include` | array | No | Elements to copy. ruleRecipients requires rules. Cell history is not copied. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Copy Workspace **Slug:** `SMARTSHEET_COPY_WORKSPACE` Copies a Smartsheet workspace. Cell history is not copied. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Copied-workspace settings. | | `include` | array | No | Element to include in the copy. Cell history is never copied. | | `skip_remap` | array | No | Reference type not to remap in the copied workspace. | | `workspace_id` | string | Yes | ID of the workspace to copy. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Cross Sheet References **Slug:** `SMARTSHEET_CREATE_CROSS_SHEET_REFERENCES` Creates a cross-sheet reference and defines its source range. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Cross-sheet reference and its source range. | | `sheet_id` | string | Yes | ID of the destination sheet being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Discussion Comment **Slug:** `SMARTSHEET_CREATE_DISCUSSION_COMMENT` Adds a comment to a discussion using JSON or multipart upload. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | No | File to attach in multipart mode. Smartsheet allows files up to 30 MB. | | `sheet_id` | string | Yes | ID of the sheet containing the discussion. | | `json_body` | object | No | Comment request used only with application/json mode. | | `upload_mode` | string ("application/json" | "multipart/form-data") | Yes | Request media type. Supply only the inputs required by the selected mode. | | `discussion_id` | string | Yes | ID of the discussion to comment on. | | `multipart_fields` | object | No | Non-file fields used only with multipart/form-data mode. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Folder In Folder **Slug:** `SMARTSHEET_CREATE_FOLDER_IN_FOLDER` Creates a new folder inside an existing Smartsheet folder. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Folder to create. | | `folder_id` | string | Yes | ID of the parent folder. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Folder In Home **Slug:** `SMARTSHEET_CREATE_FOLDER_IN_HOME` Creates a folder in Home. This Smartsheet endpoint is deprecated. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Folder to create. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Folder In Workspace **Slug:** `SMARTSHEET_CREATE_FOLDER_IN_WORKSPACE` Creates a new folder at the top level of a Smartsheet workspace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Folder to create. | | `workspace_id` | string | Yes | ID of the workspace where the folder will be created. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Proof **Slug:** `SMARTSHEET_CREATE_PROOF` Creates a proof on a row from an application/octet-stream file upload. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | Yes | File whose bytes become the new proof. | | `row_id` | string | Yes | ID of the sheet row receiving the proof. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `upload_mode` | string | No | Request media type; this operation accepts application/octet-stream only. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Proof Discussion **Slug:** `SMARTSHEET_CREATE_PROOF_DISCUSSION` Creates a discussion on a proof using exactly application/json or multipart/form-data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | No | File to attach in multipart mode. Smartsheet limits files to 30 MB. | | `proof_id` | string | Yes | ID of the original proof. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `json_body` | object | No | Discussion body used only with application/json mode. | | `upload_mode` | string ("application/json" | "multipart/form-data") | Yes | Exact request media type; supply only the matching input contract. | | `multipart_fields` | object | No | Non-file fields used only with multipart/form-data mode. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Proof Request **Slug:** `SMARTSHEET_CREATE_PROOF_REQUEST` Creates and sends a proof request. Sending the request is an irreversible external effect. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Proof request email and download settings. | | `proof_id` | string | Yes | ID of the original proof. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Proof Version **Slug:** `SMARTSHEET_CREATE_PROOF_VERSION` Creates a proof version from a binary file upload. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | Yes | File bytes for the new proof version. | | `proof_id` | string | Yes | ID of the original proof. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `upload_mode` | string | No | Request media type; proof versions support binary upload only. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Report **Slug:** `SMARTSHEET_CREATE_REPORT` Create a report from a scope, columns, definition, and destination. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Report to create. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Row Discussion **Slug:** `SMARTSHEET_CREATE_ROW_DISCUSSION` Creates a discussion on a row using JSON or multipart upload. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | No | File to attach in multipart mode. Smartsheet allows files up to 30 MB. | | `row_id` | string | Yes | ID of the row on which to create the discussion. | | `sheet_id` | string | Yes | ID of the sheet containing the row. | | `json_body` | object | No | Discussion request used only with application/json mode. | | `upload_mode` | string ("application/json" | "multipart/form-data") | Yes | Request media type. Supply only the inputs required by the selected mode. | | `multipart_fields` | object | No | Non-file fields used only with multipart/form-data mode. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Sheet Discussion **Slug:** `SMARTSHEET_CREATE_SHEET_DISCUSSION` Creates a discussion on a sheet using JSON or multipart upload. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | No | File to attach in multipart mode. Smartsheet allows files up to 30 MB. | | `sheet_id` | string | Yes | ID of the sheet on which to create the discussion. | | `json_body` | object | No | Discussion request used only with application/json mode. | | `upload_mode` | string ("application/json" | "multipart/form-data") | Yes | Request media type. Supply only the inputs required by the selected mode. | | `multipart_fields` | object | No | Non-file fields used only with multipart/form-data mode. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Sheet In Folder **Slug:** `SMARTSHEET_CREATE_SHEET_IN_FOLDER` Creates a sheet from scratch or from the specified template in the specified folder. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Sheet to create. | | `include` | array | No | Additional parameter to create a sheet from template. A comma-separated list of elements to copy from the template. | | `folder_id` | string | Yes | ID of the folder being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Sheet In Sheets Folder **Slug:** `SMARTSHEET_CREATE_SHEET_IN_SHEETS_FOLDER` Creates a sheet from scratch or from the specified template in the user's Sheets folder (Home). Deprecated by Smartsheet but retained for API 2.0 parity. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Sheet to create. | | `include` | array | No | Additional parameter to create a sheet from template. A comma-separated list of elements to copy from the template. | | `access_api_level` | string | No | Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Sheet In Workspace **Slug:** `SMARTSHEET_CREATE_SHEET_IN_WORKSPACE` Creates a sheet from scratch or from the specified template at the top-level of the specified workspace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | An object which defines the sheet to create. | | `include` | array | No | Additional parameter to create a sheet from template. A comma-separated list of elements to copy from the template. | | `workspace_id` | string | Yes | ID of the workspace being accessed. | | `access_api_level` | string | No | Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Update Request **Slug:** `SMARTSHEET_CREATE_UPDATE_REQUEST` Creates an update request and sends or schedules its email notification. This has an irreversible external effect. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Update request email, rows, columns, and optional schedule. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Webhook **Slug:** `SMARTSHEET_CREATE_WEBHOOK` Creates an inactive webhook owned by the connected API-token user. Requires a personal API access token; activate it later with Update Webhook. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Webhook definition to create. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Workspace **Slug:** `SMARTSHEET_CREATE_WORKSPACE` Creates a new Smartsheet workspace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Workspace to create. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Deactivate User **Slug:** `SMARTSHEET_DEACTIVATE_USER` Deactivate a user in the current plan, blocking all Smartsheet use without changing existing item permissions. Requires System Admin permission, is unavailable for Smartsheet Gov, and cannot deactivate externally managed or common-ISP-domain users. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | integer | Yes | ID of the user to deactivate. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Alternate Email **Slug:** `SMARTSHEET_DELETE_ALTERNATE_EMAIL` Delete an alternate email. Available only to System Admins on Enterprise or Advanced Work Management plans with the feature activated by Support. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | integer | Yes | ID of the user whose alternate email to delete. | | `alternate_email_id` | integer | Yes | ID of the alternate email to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Asset Share **Slug:** `SMARTSHEET_DELETE_ASSET_SHARE` Deletes a share for a Smartsheet asset. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `asset_id` | string | Yes | Numeric or string ID of the asset. | | `share_id` | string | Yes | Unique ID of the share. | | `asset_type` | string ("sheet" | "report" | "sight" | "workspace" | "collection" | "file") | Yes | Type of asset containing the share. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Attachment **Slug:** `SMARTSHEET_DELETE_ATTACHMENT` Delete an attachment from a Smartsheet sheet. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sheet_id` | integer | Yes | ID of the sheet being accessed. | | `attachment_id` | string | Yes | ID of the attachment to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Attachment Versions **Slug:** `SMARTSHEET_DELETE_ATTACHMENT_VERSIONS` Delete every version of an attachment, effectively removing a multi-version attachment from its parent object. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sheet_id` | integer | Yes | ID of the sheet being accessed. | | `attachment_id` | string | Yes | ID of the attachment whose versions to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Automation Rule **Slug:** `SMARTSHEET_DELETE_AUTOMATION_RULE` Deletes an automation rule from a sheet. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `automation_rule_id` | string | Yes | ID of the automation rule being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Column **Slug:** `SMARTSHEET_DELETE_COLUMN` Deletes a column from a sheet. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `column_id` | string | Yes | ID of the sheet column being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Comment **Slug:** `SMARTSHEET_DELETE_COMMENT` Deletes the specified comment. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sheet_id` | string | Yes | ID of the sheet containing the comment. | | `comment_id` | string | Yes | ID of the comment to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Dashboard **Slug:** `SMARTSHEET_DELETE_DASHBOARD` Deletes a specified Smartsheet dashboard. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sight_id` | string | Yes | ID of the dashboard to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Discussion **Slug:** `SMARTSHEET_DELETE_DISCUSSION` Deletes the specified discussion. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sheet_id` | string | Yes | ID of the sheet containing the discussion. | | `discussion_id` | string | Yes | ID of the discussion to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Favorite **Slug:** `SMARTSHEET_DELETE_FAVORITE` Removes one item from the user's Smartsheet favorites. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `favorite_id` | string | Yes | ID of the favorited sheet, report, folder, dashboard, template, or workspace. | | `favorite_type` | string ("folder" | "report" | "sheet" | "sight" | "template" | "workspace") | Yes | Favorite type. | | `x_smar_sc_actor_id` | string | No | ID of the user on whose behalf the request is made. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Folder **Slug:** `SMARTSHEET_DELETE_FOLDER` Deletes a Smartsheet folder. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `folder_id` | string | Yes | ID of the folder to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Group **Slug:** `SMARTSHEET_DELETE_GROUP` Deletes a group asynchronously. Members may briefly retain sharing access after the call returns. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | string | Yes | ID of the group to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Group Members **Slug:** `SMARTSHEET_DELETE_GROUP_MEMBERS` Removes a member from a group asynchronously. Requires group administrator or system administrator access. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | string | Yes | ID of the user to remove from the group. | | `group_id` | string | Yes | ID of the group to remove the member from. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Multiple Favorites **Slug:** `SMARTSHEET_DELETE_MULTIPLE_FAVORITES` Removes multiple favorites of one type. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `object_ids` | string | Yes | Comma-separated IDs of the favorited items to remove. | | `favorite_type` | string ("folder" | "report" | "sheet" | "sight" | "template" | "workspace") | Yes | Type of the favorited items to remove. | | `x_smar_sc_actor_id` | string | No | ID of the user on whose behalf the request is made. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Proof **Slug:** `SMARTSHEET_DELETE_PROOF` Deletes an original proof and all its versions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `proof_id` | string | Yes | ID of the original proof to delete with all versions. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Proof Requests **Slug:** `SMARTSHEET_DELETE_PROOF_REQUESTS` Deletes all requests in a proof. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `proof_id` | string | Yes | ID of the original proof whose requests will be deleted. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Proof Version **Slug:** `SMARTSHEET_DELETE_PROOF_VERSION` Deletes the current proof version identified by proof ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `proof_id` | string | Yes | ID of the current proof version to delete. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Report **Slug:** `SMARTSHEET_DELETE_REPORT` Delete a report by ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `report_id` | string | Yes | ID of the report to delete. | | `access_api_level` | string | No | Set to 1 to enable COMMENTER access behavior; 0 uses VIEWER behavior. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Report Column **Slug:** `SMARTSHEET_DELETE_REPORT_COLUMN` Delete a column from a report. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `report_id` | string | Yes | ID of the report. | | `column_virtual_id` | string | Yes | Virtual ID of the report column to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Rows **Slug:** `SMARTSHEET_DELETE_ROWS` Delete one or more rows from a Smartsheet sheet. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ids` | string | Yes | Comma-separated row IDs to delete. | | `sheet_id` | string | Yes | ID of the sheet containing the rows. | | `ignore_rows_not_found` | boolean | No | If true, ignore missing row IDs; otherwise one missing row prevents all deletions. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Sent Update Request **Slug:** `SMARTSHEET_DELETE_SENT_UPDATE_REQUEST` Deletes a sent update request only while it is pending; completed requests cannot be deleted. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `sent_update_request_id` | string | Yes | ID of the pending sent update request to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Sheet **Slug:** `SMARTSHEET_DELETE_SHEET` Deletes the sheet specified in the URL. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sheet_id` | string | Yes | ID of the sheet being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Summary Fields **Slug:** `SMARTSHEET_DELETE_SUMMARY_FIELDS` Deletes one or more summary fields from a sheet. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `ids` | string | Yes | Comma-separated sheet summary field IDs to delete. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `ignore_summary_fields_not_found` | boolean | No | Succeed when some requested field IDs do not exist. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Update Request **Slug:** `SMARTSHEET_DELETE_UPDATE_REQUEST` Terminates future scheduled delivery of an update request. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `update_request_id` | string | Yes | ID of the future scheduled update request to terminate. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Webhook **Slug:** `SMARTSHEET_DELETE_WEBHOOK` Permanently deletes a webhook owned by the connected API-token user. Requires a personal API access token; disable temporarily with Update Webhook instead. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `webhook_id` | string | Yes | ID of the webhook to permanently delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Workspace **Slug:** `SMARTSHEET_DELETE_WORKSPACE` Permanently deletes a Smartsheet workspace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `workspace_id` | string | Yes | ID of the workspace to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Downgrade User **Slug:** `SMARTSHEET_DOWNGRADE_USER` Irreversibly downgrade a user's seat in a specified plan. GUEST is valid only for external users. Requires System Admin permission. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Seat type downgrade request. | | `plan_id` | integer | Yes | Plan ID in which to downgrade the user's seat. | | `user_id` | integer | Yes | ID of the user to downgrade. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Edit Comment **Slug:** `SMARTSHEET_EDIT_COMMENT` Updates comment text. Only the user who created a comment may update it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Updated comment text. | | `sheet_id` | string | Yes | ID of the sheet containing the comment. | | `comment_id` | string | Yes | ID of the comment to update. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Alternate Email **Slug:** `SMARTSHEET_GET_ALTERNATE_EMAIL` Get one alternate email. Available only to System Admins on Enterprise or Advanced Work Management plans with the feature activated by Support. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | integer | Yes | ID of the user whose alternate email to retrieve. | | `alternate_email_id` | integer | Yes | ID of the alternate email to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Asset Share **Slug:** `SMARTSHEET_GET_ASSET_SHARE` Retrieves a specific share for a Smartsheet asset. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `asset_id` | string | Yes | Numeric or string ID of the asset. | | `share_id` | string | Yes | Unique ID of the share. | | `asset_type` | string ("sheet" | "report" | "sight" | "workspace" | "collection" | "file") | Yes | Type of asset containing the share. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Attachment **Slug:** `SMARTSHEET_GET_ATTACHMENT` Fetch attachment metadata and, for files, a temporary download URL and its lifetime. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sheet_id` | integer | Yes | ID of the sheet being accessed. | | `attachment_id` | string | Yes | ID of the attachment to fetch. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Automation Rule **Slug:** `SMARTSHEET_GET_AUTOMATION_RULE` Returns an automation rule, including its action values. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `automation_rule_id` | string | Yes | ID of the automation rule being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Column **Slug:** `SMARTSHEET_GET_COLUMN` Gets the definition of a sheet column. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `level` | integer | No | Complex column compatibility level: 0, 1, or 2. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `column_id` | string | Yes | ID of the sheet column being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Comment **Slug:** `SMARTSHEET_GET_COMMENT` Gets the comment specified by comment ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sheet_id` | string | Yes | ID of the sheet containing the comment. | | `comment_id` | string | Yes | ID of the comment to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Contact **Slug:** `SMARTSHEET_GET_CONTACT` Get a specified Smartsheet contact by contact ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include` | string | No | Set to profileImage to include the contact's profile image. | | `contact_id` | string | Yes | Opaque ID of the contact to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Cross Sheet Reference **Slug:** `SMARTSHEET_GET_CROSS_SHEET_REFERENCE` Gets a cross-sheet reference by ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `cross_sheet_reference_id` | string | Yes | ID of the cross-sheet reference being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Current User **Slug:** `SMARTSHEET_GET_CURRENT_USER` Get the connected Smartsheet user's profile. OAuth permits this identity operation without a dedicated scope. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include` | string | No | Set to groups to include groups the current user belongs to. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dashboard **Slug:** `SMARTSHEET_GET_DASHBOARD` Gets a specified Smartsheet dashboard and its widgets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `level` | integer | No | Compatibility level: 0 text, 2 multi-contact, 3 multi-picklist, or 4 metric summary data. | | `include` | string ("objectValue" | "source") | No | Optional objectValue or source details to include. | | `sight_id` | string | Yes | ID of the dashboard to retrieve. | | `numeric_dates` | boolean | No | Use Unix epoch milliseconds for date-time values. | | `access_api_level` | string | No | Set to 1 to enable COMMENTER access; 0 uses VIEWER-compatible behavior. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dashboard Path **Slug:** `SMARTSHEET_GET_DASHBOARD_PATH` Gets the hierarchical folder and workspace path of a dashboard. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sight_id` | string | Yes | ID of the dashboard whose path to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Dashboard Publish Status **Slug:** `SMARTSHEET_GET_DASHBOARD_PUBLISH_STATUS` Gets the publish settings for a Smartsheet dashboard. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sight_id` | string | Yes | ID of the dashboard whose publish settings to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Discussion **Slug:** `SMARTSHEET_GET_DISCUSSION` Gets the discussion specified by discussion ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sheet_id` | string | Yes | ID of the sheet containing the discussion. | | `discussion_id` | string | Yes | ID of the discussion to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Folder Metadata **Slug:** `SMARTSHEET_GET_FOLDER_METADATA` Gets the metadata of a Smartsheet folder. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include` | string | No | Include the source object when available. | | `folder_id` | integer | Yes | ID of the folder. | | `numeric_dates` | boolean | No | Return dates as Unix epoch milliseconds instead of ISO-8601 strings. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Folder Path **Slug:** `SMARTSHEET_GET_FOLDER_PATH` Gets the hierarchical path of a folder within its workspace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `folder_id` | string | Yes | ID of the folder. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Group **Slug:** `SMARTSHEET_GET_GROUP` Gets a group and its members. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | string | Yes | ID of the group to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Image URLs **Slug:** `SMARTSHEET_GET_IMAGE_URLS` Generate temporary read URLs for specified Smartsheet cell images. The returned URLs expire after the reported lifetime. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | array | No | Cell images for which to generate temporary read URLs. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Proof **Slug:** `SMARTSHEET_GET_PROOF` Gets a proof, optionally including attachments or discussions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include` | string ("attachments" | "discussions") | No | Optional proof content to include: attachments or discussions. | | `proof_id` | string | Yes | ID of the original proof. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Report **Slug:** `SMARTSHEET_GET_REPORT` Get one report as a paged JSON object or an offloaded Excel or CSV file. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Provider page number; cursor takes precedence when supplied. | | `level` | integer | No | Compatibility level: 0, 1, or 3. | | `cursor` | string | No | Continuation cursor returned by a previous JSON call. Omit for the first page. | | `exclude` | string ("linkInFromCellDetails" | "linksOutToCellsDetails") | No | Optional report element to exclude. | | `include` | string ("attachments" | "discussions" | "proofs" | "format" | "objectValue" | "scope" | "source" | "sourceSheets") | No | Optional report element to include. | | `page_size` | integer | No | Maximum report rows on this page, from 1 through 10,000. | | `report_id` | string | Yes | ID of the report. | | `response_format` | string ("json" | "excel" | "csv") | No | Response representation. Exports are offloaded as downloadable files. | | `access_api_level` | string | No | Set to 1 to enable COMMENTER access behavior; 0 uses VIEWER behavior. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Report Column **Slug:** `SMARTSHEET_GET_REPORT_COLUMN` Get one report column by its virtual ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `level` | integer | No | Compatibility level: 0 for text, 1 for multi-contact, or 3 for multi-picklist data. | | `report_id` | string | Yes | ID of the report. | | `column_virtual_id` | string | Yes | Virtual ID of the report column. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Report Definition **Slug:** `SMARTSHEET_GET_REPORT_DEFINITION` Get a report's filters, grouping, summarizing, and sorting definition. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `report_id` | string | Yes | ID of the report. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Report Path **Slug:** `SMARTSHEET_GET_REPORT_PATH` Get the report's hierarchical folder and workspace path. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `report_id` | string | Yes | ID of the report. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Report Publish Status **Slug:** `SMARTSHEET_GET_REPORT_PUBLISH_STATUS` Get a report's publishing settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `report_id` | string | Yes | ID of the report. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Row **Slug:** `SMARTSHEET_GET_ROW` Get a Smartsheet row by sheet and row ID, with optional related row data. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `level` | integer | No | Object-value compatibility level from 0 to 2. | | `row_id` | string | Yes | ID of the row to retrieve. | | `exclude` | string ("filteredOutRows" | "linkInFromCellDetails" | "linksOutToCellsDetails" | "nonexistentCells") | No | Optional row elements to exclude. | | `include` | string ("attachments" | "columns" | "columnType" | "discussions" | "filters" | "format" | "objectValue" | "proofs" | "rowPermalink" | "writerInfo") | No | Optional row elements to include. | | `sheet_id` | string | Yes | ID of the sheet containing the row. | | `access_api_level` | string | No | Access API level; use 1 to permit COMMENTER semantics. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Sent Update Request **Slug:** `SMARTSHEET_GET_SENT_UPDATE_REQUEST` Gets the specified sent update request on the sheet. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `sent_update_request_id` | string | Yes | ID of the sent update request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Server Info **Slug:** `SMARTSHEET_GET_SERVER_INFO` Get Smartsheet application constants, formats, and supported locales. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Sheet **Slug:** `SMARTSHEET_GET_SHEET` Gets a sheet in the format specified, based on the sheet Id. Returns one page and a continuation cursor. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned. | | `level` | integer | No | Specifies whether object data types, such as multi-contact data are returned in a backwards-compatible, text format in text/number columns. - Set `level=0` (default) to use text/number columns for multi-contact data and multi-picklist data. - Set `level=1` to use multiple-entry contact list columns for multi-contact data; multi-picklist data is returned in text/number columns. - Set `level=2` to use multiple-entry contact list columns for multi-contact data and use multiple-entry picklist columns for multi-picklist data. | | `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. | | `exclude` | array | No | Comma-separated element types to exclude from the response. | | `include` | array | No | Comma-separated response expansions. Discussion attachments require both attachments and discussions. | | `row_ids` | string | No | A comma-separated list of row Ids on which to filter the rows included in the result. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `filter_id` | string | No | Overrides the existing include={filters} parameter if both are supplied. Applies the given filter (if accessible by the calling user) and marks the affected rows as "filteredOut": true. | | `page_size` | integer | No | The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request. | | `column_ids` | string | No | A comma-separated list of column ids. The response contains only the specified columns in the "columns" array, and individual rows' "cells" array only contains cells in the specified columns. | | `paper_size` | string ("LETTER" | "LEGAL" | "WIDE" | "ARCHD" | "A4" | "A3" | "A2" | "A1" | "A0") | No | applies to PDF format only | | `row_numbers` | string | No | A comma-separated list of row numbers on which to filter the rows included in the result. Non-existent row numbers are ignored. | | `response_format` | string ("json" | "pdf" | "excel" | "csv") | No | Response representation. Non-JSON exports are returned as downloadable files with the provider MIME type. | | `access_api_level` | string | No | Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1. | | `if_version_after` | integer | No | If version specified is still the current sheet version, then returns an abbreviated Sheet object with only the sheet version property. Otherwise, if the sheet has been modified, returns the complete Sheet object. Intended to allow clients with a cached copy to make sure they have the latest version. | | `rows_modified_since` | string | No | Filter to return only rows that have been modified since the date/time provided. Date should be in ISO-8601 format. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Sheet Path **Slug:** `SMARTSHEET_GET_SHEET_PATH` Gets the hierarchical path of the sheet, showing its location within folders and workspace, if workspace-level access is provided. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sheet_id` | string | Yes | ID of the sheet being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Sheet Publish Status **Slug:** `SMARTSHEET_GET_SHEET_PUBLISH_STATUS` Gets the sheet's 'Publish' settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sheet_id` | string | Yes | ID of the sheet being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Sheet Summary **Slug:** `SMARTSHEET_GET_SHEET_SUMMARY` Returns all summary fields defined on a sheet, including requested format or writer details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `exclude` | string ("displayValue" | "image" | "imageAltText") | No | Optional summary details to exclude. | | `include` | string ("format" | "writerInfo") | No | Optional summary details to include. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Sheet Version **Slug:** `SMARTSHEET_GET_SHEET_VERSION` Gets the sheet version without loading the entire sheet. The following actions increment sheet version: add/modify cell value add/modify discussion/comment add/modify row add/remove/update version attachment cell updated via cell link change formatting. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sheet_id` | string | Yes | ID of the sheet being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Update Request **Slug:** `SMARTSHEET_GET_UPDATE_REQUEST` Gets an update request that has a future delivery schedule. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `update_request_id` | string | Yes | ID of the update request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get User **Slug:** `SMARTSHEET_GET_USER` Get a Smartsheet user by ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | integer | Yes | ID of the user to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Webhook **Slug:** `SMARTSHEET_GET_WEBHOOK` Gets a webhook owned by the connected API-token user, including its configured event patterns. Requires a personal API access token. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `webhook_id` | string | Yes | ID of the webhook to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Workspace Metadata **Slug:** `SMARTSHEET_GET_WORKSPACE_METADATA` Gets metadata for a specified Smartsheet workspace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include` | string | No | Set to source to include creation-source information when available. | | `workspace_id` | integer | Yes | ID of the workspace. | | `numeric_dates` | boolean | No | Return date-times as Unix epoch milliseconds instead of ISO-8601 strings. | | `access_api_level` | string | No | Set to 1 to allow COMMENTER access in inputs and responses; 0 uses the backwards-compatible VIEWER behavior. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Import Sheet From Csv Xlsx **Slug:** `SMARTSHEET_IMPORT_SHEET_FROM_CSV_XLSX` Imports CSV or XLSX data into a new sheet in the top-level "Sheets" folder. Deprecated by Smartsheet but retained for API 2.0 parity. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | Yes | File to upload. Required for binary or multipart upload modes that declare a file part. | | `sheet_name` | string | Yes | Desired name of the sheet. | | `content_type` | string ("text/csv" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet") | Yes | Required file media type: text/csv for CSV or the XLSX media type for Excel workbooks. | | `header_row_index` | string | No | A zero-based integer indicating the row number to use for column names. Rows before this are omitted. If not specified, the default values are Column1, Column2, etc. | | `primary_column_index` | string | No | A zero-based integer indicating the column to designate as primary. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Import Sheet Into Folder **Slug:** `SMARTSHEET_IMPORT_SHEET_INTO_FOLDER` Imports CSV or XLSX data into a new sheet in the specified folder. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | Yes | File to upload. Required for binary or multipart upload modes that declare a file part. | | `folder_id` | string | Yes | ID of the folder being accessed. | | `sheet_name` | string | Yes | Desired name of the sheet. | | `content_type` | string ("text/csv" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet") | Yes | Required file media type: text/csv for CSV or the XLSX media type for Excel workbooks. | | `header_row_index` | string | No | A zero-based integer indicating the row number to use for column names. Rows before this are omitted. If not specified, the default values are Column1, Column2, etc. | | `primary_column_index` | string | No | A zero-based integer indicating the column to designate as primary. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Import Sheet Into Workspace **Slug:** `SMARTSHEET_IMPORT_SHEET_INTO_WORKSPACE` Imports CSV or XLSX data into a new sheet in the specified workspace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | Yes | File to upload. Required for binary or multipart upload modes that declare a file part. | | `sheet_name` | string | Yes | Desired name of the sheet. | | `content_type` | string ("text/csv" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet") | Yes | Required file media type: text/csv for CSV or the XLSX media type for Excel workbooks. | | `workspace_id` | string | Yes | ID of the workspace being accessed. | | `header_row_index` | string | No | A zero-based integer indicating the row number to use for column names. Rows before this are omitted. If not specified, the default values are Column1, Column2, etc. | | `primary_column_index` | string | No | A zero-based integer indicating the column to designate as primary. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Alternate Emails **Slug:** `SMARTSHEET_LIST_ALTERNATE_EMAILS` List a user's alternate email addresses. Available only to System Admins on Enterprise or Advanced Work Management plans with the feature activated by Support. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | integer | Yes | ID of the user whose alternate emails to list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Asset Shares **Slug:** `SMARTSHEET_LIST_ASSET_SHARES` Retrieves one page of users and groups an asset is shared with and their access levels. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. | | `asset_id` | string | Yes | Numeric or string ID of the asset whose shares to list. | | `max_items` | integer | No | Shares to return on this page (100-1000, in multiples of 100). | | `asset_type` | string ("sheet" | "report" | "sight" | "workspace" | "collection" | "file") | Yes | Type of asset whose shares to list. | | `sharing_include` | string ("ITEM" | "WORKSPACE") | No | Include item-level or workspace-level shares. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Attachment Versions **Slug:** `SMARTSHEET_LIST_ATTACHMENT_VERSIONS` Get one page of an attachment's versions, ordered from newest to oldest. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number to request. | | `cursor` | string | No | Continuation cursor from a previous call. Omit for the first page. | | `sheet_id` | integer | Yes | ID of the sheet being accessed. | | `page_size` | integer | No | Maximum attachment versions to return on this page. | | `include_all` | boolean | No | Whether to return all versions without pagination. Do not combine true with page, page_size, or cursor. | | `attachment_id` | string | Yes | ID of the attachment whose versions to list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Automation Rules **Slug:** `SMARTSHEET_LIST_AUTOMATION_RULES` Returns one page of automation rules associated with a sheet. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number to return. | | `cursor` | string | No | Continuation cursor returned by a previous call. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `page_size` | integer | No | Maximum rules to return per page. | | `include_all` | boolean | No | Return all rules without pagination. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Cell History **Slug:** `SMARTSHEET_LIST_CELL_HISTORY` Return one page of cell modification history. This resource-intensive endpoint consumes 10 rate-limit units, so avoid parallel calls and wait at least 60 seconds after a 429. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number to request. | | `level` | integer | No | Object-value compatibility level from 0 to 2. | | `cursor` | string | No | Continuation cursor from a previous call. Omit for the first page. | | `row_id` | string | Yes | ID of the row containing the cell. | | `include` | string ("columnType" | "objectValue") | No | Additional cell history fields to include. | | `sheet_id` | string | Yes | ID of the sheet containing the cell. | | `column_id` | string | Yes | ID of the column containing the cell. | | `page_size` | integer | No | Maximum history records to return on this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Columns **Slug:** `SMARTSHEET_LIST_COLUMNS` Gets one page of columns belonging to a sheet. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number to return. | | `level` | integer | No | Complex column compatibility level: 0, 1, or 2. | | `cursor` | string | No | Continuation cursor returned by a previous call. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `page_size` | integer | No | Maximum columns to return per page. | | `include_all` | boolean | No | Return all columns without pagination. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Contacts **Slug:** `SMARTSHEET_LIST_CONTACTS` Get one page of the connected user's Smartsheet contacts and return a continuation cursor. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number to request directly. Defaults to 1. | | `cursor` | string | No | Continuation cursor from a previous call. Omit for the first page. | | `page_size` | integer | No | Maximum number of contacts to return on this page. Defaults to 100. | | `include_all` | boolean | No | Whether to return all contacts without pagination. Do not combine true with page, page_size, or cursor. | | `numeric_dates` | boolean | No | Whether dates are sent and returned as Unix epoch milliseconds. | | `modified_since` | string | No | Return contacts modified at or after this ISO 8601 timestamp, or Unix epoch milliseconds when numeric_dates is true. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Cross Sheet References **Slug:** `SMARTSHEET_LIST_CROSS_SHEET_REFERENCES` Lists one page of cross-sheet references for a sheet. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number to return. | | `cursor` | string | No | Continuation cursor returned by a previous call. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `page_size` | integer | No | Maximum references to return per page. | | `include_all` | boolean | No | Return all references without pagination. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Dashboards **Slug:** `SMARTSHEET_LIST_DASHBOARDS` Gets one page of dashboards the connected user can access. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque continuation cursor returned by a previous call. Omit for the first page. | | `max_items` | integer | No | Maximum dashboards to return on this page (1-1000). | | `numeric_dates` | boolean | No | Use Unix epoch milliseconds for date-time values. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Discussion Attachments **Slug:** `SMARTSHEET_LIST_DISCUSSION_ATTACHMENTS` Get one page of attachments in a Smartsheet discussion. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number to request. | | `cursor` | string | No | Continuation cursor from a previous call. Omit for the first page. | | `sheet_id` | integer | Yes | ID of the sheet being accessed. | | `page_size` | integer | No | Maximum attachments to return on this page. | | `include_all` | boolean | No | Whether to return all attachments without pagination. Do not combine true with page, page_size, or cursor. | | `discussion_id` | string | Yes | ID of the discussion whose attachments to list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Events **Slug:** `SMARTSHEET_LIST_EVENTS` Fetch Smartsheet organization events for a System Admin. Requires the Event Reporting premium add-on. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `to` | string | No | Latest event time in ISO 8601 format; requires since. | | `since` | string | No | Earliest event time in ISO 8601 format. Supply exactly one of since or stream_position. | | `max_count` | integer | No | Maximum events to return, from 1 through 10,000. | | `numeric_dates` | boolean | No | Whether dates are sent and returned as Unix epoch milliseconds. | | `accept_encoding` | string ("deflate" | "gzip") | No | Optional response compression encoding: deflate or gzip. | | `managed_plan_id` | string | No | Managed plan whose events to list, when authorized. | | `stream_position` | string | No | nextStreamPosition from a previous response. Use instead of since. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Favorites **Slug:** `SMARTSHEET_LIST_FAVORITES` Gets the user's favorites and returns one page with a continuation cursor. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number to return. | | `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. | | `include` | string ("directId" | "name") | No | Optional favorite detail to include. | | `page_size` | integer | No | Maximum number of favorites to return per page. | | `include_all` | boolean | No | If true, return all results without pagination. | | `x_smar_sc_actor_id` | string | No | ID of the user on whose behalf the request is made. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Filtered Events **Slug:** `SMARTSHEET_LIST_FILTERED_EVENTS` Fetch events related to selected Smartsheet sheets and workspaces for a non-admin user. Requires the Event Reporting premium add-on. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Documented Smartsheet event filter body. | | `accept_encoding` | string ("deflate" | "gzip") | No | Optional response compression encoding: deflate or gzip. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Folder Children **Slug:** `SMARTSHEET_LIST_FOLDER_CHILDREN` Returns one page of immediate resources inside a Smartsheet folder. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. | | `include` | array | No | Comma-separated child metadata to include. | | `folder_id` | integer | Yes | ID of the folder. | | `max_items` | integer | No | Items per page (100-1000, in multiples of 100). | | `numeric_dates` | boolean | No | Return dates as Unix epoch milliseconds instead of ISO-8601 strings. | | `access_api_level` | string | No | Access API level; use 1 to include COMMENTER access. | | `children_resource_types` | array | No | Comma-separated child resource types to include. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Folders In Home **Slug:** `SMARTSHEET_LIST_FOLDERS_IN_HOME` Lists folders in the Sheets folder. This Smartsheet endpoint is deprecated. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number to return. | | `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. | | `page_size` | integer | No | Maximum number of folders to return per page. | | `include_all` | boolean | No | If true, return all results without pagination. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Home Contents **Slug:** `SMARTSHEET_LIST_HOME_CONTENTS` Gets all Home objects shared to the user. This Smartsheet endpoint is deprecated. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `include` | string ("source" | "distributionLink" | "ownerInfo" | "sheetVersion") | No | Comma-separated optional elements to include in the response. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Org Groups **Slug:** `SMARTSHEET_LIST_ORG_GROUPS` Gets one page of all groups in an organization account, with a continuation cursor. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number to return. | | `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. | | `page_size` | integer | No | Maximum number of groups to return on this page. | | `include_all` | boolean | No | Return all groups without pagination. | | `numeric_dates` | boolean | No | Use Unix epoch milliseconds for date-time values. | | `modified_since` | string | No | Return groups modified at or after this ISO-8601 timestamp or Unix epoch value. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Org Sheets **Slug:** `SMARTSHEET_LIST_ORG_SHEETS` Gets a summarized list of all sheets owned by the members of the organization account. Plan or role restrictions apply; see plan_role_constraints. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `modified_since` | string | No | When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified. If you need to keep track of frequent changes, it may be more useful to use Get Sheet Version. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Proof Attachments **Slug:** `SMARTSHEET_LIST_PROOF_ATTACHMENTS` Gets one page of non-discussion attachments in a proof. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number to return. | | `cursor` | string | No | Continuation cursor from a previous call. Omit for the first page. | | `proof_id` | string | Yes | ID of the original proof. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `page_size` | integer | No | Maximum attachments to return on this page. | | `include_all` | boolean | No | Return all results without pagination; do not combine true with page, page_size, or cursor. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Proof Discussions **Slug:** `SMARTSHEET_LIST_PROOF_DISCUSSIONS` Gets one page of discussions in a proof. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number to return. | | `cursor` | string | No | Continuation cursor from a previous call. Omit for the first page. | | `include` | string ("attachments" | "comments") | No | Optional content to include; attachments is effective only when comments is also requested. | | `proof_id` | string | Yes | ID of the original proof. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `page_size` | integer | No | Maximum discussions to return on this page. | | `include_all` | boolean | No | Return all results without pagination; do not combine true with page, page_size, or cursor. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Proof Request Actions **Slug:** `SMARTSHEET_LIST_PROOF_REQUEST_ACTIONS` Gets one page of summarized request actions for a proof. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number to return. | | `cursor` | string | No | Continuation cursor from a previous call. Omit for the first page. | | `proof_id` | string | Yes | ID of the original proof. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `page_size` | integer | No | Maximum actions to return on this page. | | `include_all` | boolean | No | Return all results without pagination; do not combine true with page, page_size, or cursor. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Proofs **Slug:** `SMARTSHEET_LIST_PROOFS` Gets one page of proofs for a sheet. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number to return. | | `cursor` | string | No | Continuation cursor from a previous call. Omit for the first page. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `page_size` | integer | No | Maximum proofs to return on this page. | | `include_all` | boolean | No | Return all results without pagination; do not combine true with page, page_size, or cursor. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Proof Versions **Slug:** `SMARTSHEET_LIST_PROOF_VERSIONS` Gets one page of proof versions from newest to oldest. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number to return. | | `cursor` | string | No | Continuation cursor from a previous call. Omit for the first page. | | `proof_id` | string | Yes | ID of the original proof. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `page_size` | integer | No | Maximum versions to return on this page. | | `include_all` | boolean | No | Return all results without pagination; do not combine true with page, page_size, or cursor. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Report Columns **Slug:** `SMARTSHEET_LIST_REPORT_COLUMNS` List one page of columns for a report. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `level` | integer | No | Compatibility level: 0, 1, or 3. | | `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. | | `max_items` | integer | No | Maximum columns on this page, from 100 through 1000 in increments of 100. | | `report_id` | string | Yes | ID of the report. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Reports **Slug:** `SMARTSHEET_LIST_REPORTS` List all reports accessible to the connected user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `modified_since` | string | No | Only return reports modified on or after this ISO 8601 timestamp or epoch value. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Report Scope **Slug:** `SMARTSHEET_LIST_REPORT_SCOPE` List one page of source sheets and workspaces in a report's scope. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. | | `max_items` | integer | No | Maximum scope entries on this page, from 100 through 1000 in increments of 100. | | `report_id` | string | Yes | ID of the report. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Row Attachments **Slug:** `SMARTSHEET_LIST_ROW_ATTACHMENTS` Get one page of row- and row-discussion-level attachments on a Smartsheet row. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number to request. | | `cursor` | string | No | Continuation cursor from a previous call. Omit for the first page. | | `row_id` | integer | Yes | ID of the row whose attachments to list. | | `sheet_id` | integer | Yes | ID of the sheet being accessed. | | `page_size` | integer | No | Maximum attachments to return on this page. | | `include_all` | boolean | No | Whether to return all attachments without pagination. Do not combine true with page, page_size, or cursor. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Row Discussions **Slug:** `SMARTSHEET_LIST_ROW_DISCUSSIONS` Gets one page of discussions associated with a row. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number to request. | | `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. | | `row_id` | string | Yes | ID of the row whose discussions to list. | | `include` | string ("attachments" | "comments") | No | Optional discussion elements to include. | | `sheet_id` | string | Yes | ID of the sheet containing the row. | | `page_size` | integer | No | Maximum discussions to return on this page. | | `include_all` | boolean | No | Return all results without pagination. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Sent Update Requests **Slug:** `SMARTSHEET_LIST_SENT_UPDATE_REQUESTS` Lists summarized sent update requests on the sheet. Returns one page and a continuation cursor. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number to return. | | `cursor` | string | No | Continuation cursor from a previous call. Omit for the first page. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `page_size` | integer | No | Maximum number of sent requests on this page. | | `include_all` | boolean | No | Return all results without pagination. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Sheet Attachments **Slug:** `SMARTSHEET_LIST_SHEET_ATTACHMENTS` Get one page of sheet-, row-, and discussion-level attachments on a sheet. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number to request. | | `cursor` | string | No | Continuation cursor from a previous call. Omit for the first page. | | `sheet_id` | integer | Yes | ID of the sheet whose attachments to list. | | `page_size` | integer | No | Maximum attachments to return on this page. | | `include_all` | boolean | No | Whether to return all attachments without pagination. Do not combine true with page, page_size, or cursor. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Sheet Discussions **Slug:** `SMARTSHEET_LIST_SHEET_DISCUSSIONS` Gets one page of discussions associated with a sheet. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number to request. | | `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. | | `include` | string ("attachments" | "comments") | No | Optional discussion elements to include. | | `sheet_id` | string | Yes | ID of the sheet whose discussions to list. | | `page_size` | integer | No | Maximum discussions to return on this page. | | `include_all` | boolean | No | Return all results without pagination. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Sheets **Slug:** `SMARTSHEET_LIST_SHEETS` Gets a list of all sheets that the user has access to. The list contains an abbreviated Sheet object for each sheet. Returns one page and a continuation cursor. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned. | | `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. | | `include` | string ("sheetVersion" | "source") | No | A comma-separated list of optional elements to include in the response: * **sheetVersion** - current version number of each sheet, should not be combined with pagination * **source** - the Source object for any sheet that was created from another sheet, if any | | `page_size` | integer | No | The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request. | | `include_all` | boolean | No | If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified). | | `numeric_dates` | boolean | No | You can optionally choose to receive and send dates/times in numeric format, as milliseconds since the UNIX epoch (midnight on January 1, 1970 in UTC time), using the query string parameter numericDates with a value of true. This query parameter works for any API request. | | `modified_since` | string | No | When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified. If you need to keep track of frequent changes, it may be more useful to use Get Sheet Version. | | `access_api_level` | string | No | Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Summary Fields **Slug:** `SMARTSHEET_LIST_SUMMARY_FIELDS` Returns one page of sheet summary fields and a continuation cursor. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number to return. | | `cursor` | string | No | Continuation cursor from a previous call. Omit for the first page. | | `exclude` | string ("displayValue" | "image" | "imageAltText") | No | Optional summary details to exclude. | | `include` | string ("format" | "writerInfo") | No | Optional summary details to include. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `page_size` | integer | No | Maximum summary fields on this page. | | `include_all` | boolean | No | Return all fields without pagination. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Update Requests **Slug:** `SMARTSHEET_LIST_UPDATE_REQUESTS` Gets one page of update requests with future schedules and a continuation cursor. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number to return. | | `cursor` | string | No | Continuation cursor from a previous call. Omit for the first page. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `page_size` | integer | No | Maximum update requests on this page. | | `include_all` | boolean | No | Return all results without pagination. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List User Plans **Slug:** `SMARTSHEET_LIST_USER_PLANS` List one token-paginated page of plans to which a user belongs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor from a previous response's next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page. | | `include` | string | No | Set to planName to include the owning organization name. | | `user_id` | integer | Yes | ID of the user whose plans to list. | | `max_items` | integer | No | Maximum plans to return, from 100 to 1000 in increments of 100. | | `display_contributor_seat_type` | boolean | No | Display CONTRIBUTOR for free-tier plan seats. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Users **Slug:** `SMARTSHEET_LIST_USERS` List organization users with optional email, plan, and seat filters. Organization directory access can require a qualifying plan and System Admin role. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Page number to return; defaults to 1. | | `email` | string | No | Comma-separated email addresses to filter by. | | `cursor` | string | No | Continuation cursor from a previous response's next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page. | | `include` | string | No | Set to lastLogin to include eligible users' last login time. | | `plan_id` | integer | No | Plan ID whose user seat types should be returned. System Admin only. | | `page_size` | integer | No | Maximum users per page; defaults to 100. | | `seat_type` | string ("MEMBER" | "PROVISIONAL_MEMBER" | "GUEST" | "CONTRIBUTOR" | "VIEWER") | No | Filter by seat type. System Admin only; VIEWER is deprecated. | | `include_all` | boolean | No | Return all users without pagination. | | `numeric_dates` | boolean | No | Return dates as milliseconds since the Unix epoch. | | `display_contributor_seat_type` | boolean | No | Display CONTRIBUTOR for users with a free-tier seat when no seat type filter is set. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Webhooks **Slug:** `SMARTSHEET_LIST_WEBHOOKS` Gets one page of webhooks owned by the connected API-token user. Requires a personal API access token because OAuth access is shared across the third-party app. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `page` | integer | No | Provider page number for the first request; cursor takes precedence when supplied. | | `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. | | `page_size` | integer | No | Webhooks to return on this page (1-10,000). | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Workspace Children **Slug:** `SMARTSHEET_LIST_WORKSPACE_CHILDREN` Retrieves one page of immediate child resources from a specified Smartsheet workspace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. | | `include` | array | No | Comma-separated response expansions: source creation details and owner information. | | `max_items` | integer | No | Maximum child resources to return (100-1000, in multiples of 100). | | `workspace_id` | integer | Yes | ID of the workspace. | | `numeric_dates` | boolean | No | Return date-times as Unix epoch milliseconds instead of ISO-8601 strings. | | `access_api_level` | string | No | Set to 1 to allow COMMENTER access in inputs and responses; 0 uses the backwards-compatible VIEWER behavior. | | `children_resource_types` | array | No | Comma-separated child types to include. Include sheets whenever templates is requested. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Workspaces **Slug:** `SMARTSHEET_LIST_WORKSPACES` Retrieves one page of workspace metadata for workspaces the connected user can access. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Continuation cursor returned by a previous call. Omit for the first page. | | `max_items` | integer | No | Maximum workspaces to return on this page (100-1000). | | `access_api_level` | string | No | Set to 1 to allow COMMENTER access in inputs and responses; 0 uses the backwards-compatible VIEWER behavior. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Make Alternate Email Primary **Slug:** `SMARTSHEET_MAKE_ALTERNATE_EMAIL_PRIMARY` Make a confirmed alternate address the user's primary email. The current primary domain must be validated, and the alternate address must be confirmed or its domain validated. Available only to System Admins on Enterprise or Advanced Work Management plans with the feature activated by Support. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | integer | Yes | ID of the user whose primary email to change. | | `alternate_email_id` | integer | Yes | ID of the alternate email to make primary. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Move Dashboard **Slug:** `SMARTSHEET_MOVE_DASHBOARD` Moves a specified Smartsheet dashboard to another container. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Destination for the dashboard. | | `sight_id` | string | Yes | ID of the dashboard to move. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Move Folder **Slug:** `SMARTSHEET_MOVE_FOLDER` Moves a Smartsheet folder to another container. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | New folder destination. | | `folder_id` | string | Yes | ID of the folder to move. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Move Rows To Another Sheet **Slug:** `SMARTSHEET_MOVE_ROWS_TO_ANOTHER_SHEET` Move selected rows to the bottom of another Smartsheet sheet. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Source row IDs and destination sheet. | | `include` | string ("attachments" | "discussions") | No | Additional row elements to move. | | `sheet_id` | string | Yes | ID of the source sheet. | | `ignore_rows_not_found` | boolean | No | Ignore source row IDs that do not exist. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Move Sheet **Slug:** `SMARTSHEET_MOVE_SHEET` Moves the specified sheet to a new location. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Destination to move the specified sheet. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reactivate User **Slug:** `SMARTSHEET_REACTIVATE_USER` Reactivate a user deactivated less than 30 days ago. Requires System Admin permission, is unavailable for Smartsheet Gov, and cannot reactivate external, out-of-plan, or common-ISP-domain users. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | integer | Yes | ID of the user to reactivate. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove Report Scope **Slug:** `SMARTSHEET_REMOVE_REPORT_SCOPE` Remove source sheets from a report by sheet or parent workspace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | array | No | Sheets or workspaces to remove, at most 100. | | `report_id` | string | Yes | ID of the report. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove User From Organization **Slug:** `SMARTSHEET_REMOVE_USER_FROM_ORGANIZATION` Remove a user from the organization, optionally removing shares or transferring assets. Requires System Admin permission and can fail for managed users, main contacts, or invalid transfer recipients. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `user_id` | integer | Yes | ID of the user to remove. | | `transfer_to` | integer | No | Qualified Group Admin user ID that receives owned groups and, when requested, assets. | | `transfer_sheets` | boolean | No | Transfer all owned assets and groups to transfer_to. | | `remove_from_sharing` | boolean | No | Remove the user's access to all organization and plan assets. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Remove User From Plan **Slug:** `SMARTSHEET_REMOVE_USER_FROM_PLAN` Deactivate a user's membership in a plan while preserving ownership and read-only access. This operation is unavailable to legacy plans and requires an eligible System Admin caller. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `plan_id` | integer | Yes | Plan ID from which to remove the user. | | `user_id` | integer | Yes | ID of the user to remove from the plan. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reset Webhook Shared Secret **Slug:** `SMARTSHEET_RESET_WEBHOOK_SHARED_SECRET` Irreversibly rotates a webhook secret owned by the connected API-token user after explicit confirmation. Requires a personal API access token. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `webhook_id` | string | Yes | ID of the webhook whose shared secret will be rotated. | | `confirm_secret_rotation` | boolean | Yes | Must be true to confirm that the current shared secret will immediately stop working. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Everything **Slug:** `SMARTSHEET_SEARCH_EVERYTHING` Searches all sheets that the user can access, for the specified text. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Text with which to perform the search. **Tip:** To match the exact text, wrap the query in double-quotes. | | `scopes` | array | No | If search fails, try using an array for each type of this comma-separated list of search filters. | | `include` | string | No | When specified with a value of `"favoriteFlag"`, the response indicates which returned items and item parents belong to the user's favorites. **Scenarios:** - If a matching item is a favorite, the search result for that item includes this property setting: `"favorite": true` - If the parent of a matching item is a favorite, the search result for that item includes this property setting: `"parentObjectFavorite": true` | | `location` | string | No | **Deprecated** When specified with a value of **personalWorkspace**, limits the response to only those items in the user's workspaces. | | `modified_since` | string | No | When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified. If you need to keep track of frequent changes, it may be more useful to use Get Sheet Version. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Search Sheet **Slug:** `SMARTSHEET_SEARCH_SHEET` Gets a list of the user's search results in a sheet, based on a query. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | Text with which to perform the search. **Tip:** To match the exact text, wrap the query in double-quotes. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send Report By Email **Slug:** `SMARTSHEET_SEND_REPORT_BY_EMAIL` Send a report attachment by email. This has an irreversible external effect. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Email and attachment settings. | | `report_id` | string | Yes | ID of the report to send. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send Rows By Email **Slug:** `SMARTSHEET_SEND_ROWS_BY_EMAIL` Send selected Smartsheet rows by email. This operation has an irreversible external effect. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Rows, columns, recipients, and email presentation options. | | `sheet_id` | string | Yes | ID of the sheet containing the rows. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send Sheet By Email **Slug:** `SMARTSHEET_SEND_SHEET_BY_EMAIL` Sends the sheet as a PDF attachment via email to the designated recipients. This operation has an irreversible external effect. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | [SheetEmail object](/api/smartsheet/openapi/sendviaemail/sheetemail) | | `sheet_id` | string | Yes | ID of the sheet being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Set Dashboard Publish Status **Slug:** `SMARTSHEET_SET_DASHBOARD_PUBLISH_STATUS` Publishes or unpublishes a Smartsheet dashboard. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Desired dashboard publish settings. | | `sight_id` | string | Yes | ID of the dashboard to publish or unpublish. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Set Report Publish Status **Slug:** `SMARTSHEET_SET_REPORT_PUBLISH_STATUS` Set report publishing status and return the resulting public URL when enabled. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | New report publishing settings. | | `report_id` | string | Yes | ID of the report. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Set Sheet Publish Status **Slug:** `SMARTSHEET_SET_SHEET_PUBLISH_STATUS` Sets the publish status of the sheet and returns the new status, including the URLs of any enabled publishings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | SheetPublish object. For Read Only, if you do not specify a value for **readOnlyFullAccessibleBy**, the value defaults to the organization-level 'Sheet Publishing' setting (if the sheet owner belongs to an organization account) or to **ALL** (if the sheet owner does not belong to an organization account). For Read Write, if you do not specify a value for **readWriteAccessibleBy**, the value defaults to the organization-level 'Sheet Publishing' setting (if the sheet owner belongs to an organization account) or to **ALL** (if the sheet owner does not belong to an organization account). | | `sheet_id` | string | Yes | ID of the sheet being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Share Asset **Slug:** `SMARTSHEET_SHARE_ASSET` Shares a Smartsheet asset with specified users or groups. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | array | No | Recipients and access levels to add. | | `asset_id` | string | Yes | Numeric or string ID of the asset to share. | | `asset_type` | string ("sheet" | "report" | "sight" | "workspace" | "collection" | "file") | Yes | Type of asset to share. | | `send_email` | boolean | No | Notify recipients by email; at most 1000 emails are sent. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Sort Rows In Sheet **Slug:** `SMARTSHEET_SORT_ROWS_IN_SHEET` Sort all rows in a Smartsheet sheet by one or more prioritized column criteria. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Columns and directions used to sort the sheet rows. | | `sheet_id` | string | Yes | ID of the sheet whose rows to sort. | | `include_exclude` | string | No | Relevant Get Sheet include or exclude query options accepted by this operation. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Asset Share **Slug:** `SMARTSHEET_UPDATE_ASSET_SHARE` Updates the access level of a share for a Smartsheet asset. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | New access level for the share. | | `asset_id` | string | Yes | Numeric or string ID of the asset. | | `share_id` | string | Yes | Unique ID of the share. | | `asset_type` | string ("sheet" | "report" | "sight" | "workspace" | "collection" | "file") | Yes | Type of asset containing the share. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Automation Rule **Slug:** `SMARTSHEET_UPDATE_AUTOMATION_RULE` Updates an existing automation rule. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Automation rule fields to update. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `automation_rule_id` | string | Yes | ID of the automation rule being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Column **Slug:** `SMARTSHEET_UPDATE_COLUMN` Updates, moves, or renames a sheet column. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Column fields to update. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `column_id` | string | Yes | ID of the sheet column being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Dashboard **Slug:** `SMARTSHEET_UPDATE_DASHBOARD` Renames a specified Smartsheet dashboard. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Dashboard fields to update. | | `sight_id` | string | Yes | ID of the dashboard to rename. | | `numeric_dates` | boolean | No | Use Unix epoch milliseconds for date-time values. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Folder **Slug:** `SMARTSHEET_UPDATE_FOLDER` Updates a Smartsheet folder. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Folder fields to update. | | `folder_id` | string | Yes | ID of the folder to update. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Group **Slug:** `SMARTSHEET_UPDATE_GROUP` Updates a group. Requires group administrator or system administrator access. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Group fields to update. | | `group_id` | string | Yes | ID of the group to update. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Proof Status **Slug:** `SMARTSHEET_UPDATE_PROOF_STATUS` Sets a proof as complete or incomplete. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Proof completion status update. | | `proof_id` | string | Yes | ID of the original proof. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Report Column **Slug:** `SMARTSHEET_UPDATE_REPORT_COLUMN` Update a report column's title, position, visibility, or width. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Report column fields to update. | | `report_id` | string | Yes | ID of the report. | | `column_virtual_id` | string | Yes | Virtual ID of the report column. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Report Definition **Slug:** `SMARTSHEET_UPDATE_REPORT_DEFINITION` Create or entirely replace a report definition. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Complete replacement report definition. | | `report_id` | string | Yes | ID of the report. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Rows **Slug:** `SMARTSHEET_UPDATE_ROWS` Update one row or a batch of up to 500 rows, including cells and location operations such as moving, indenting, or outdenting. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | Yes | One row update or an array of up to 500 row updates. | | `sheet_id` | string | Yes | ID of the sheet containing the rows. | | `override_format` | boolean | No | Clear existing formatting from updated rows and cells. | | `access_api_level` | string | No | Access API level; use 1 to permit COMMENTER semantics. | | `override_validation` | boolean | No | Allow values outside column validation limits. | | `allow_partial_success` | boolean | No | Allow valid rows to succeed when others fail. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Sheet **Slug:** `SMARTSHEET_UPDATE_SHEET` Updates the sheet specified in the URL. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | [Sheet object](/api/smartsheet/openapi/sheets/sheet) limited to the following attributes: * **name** (optional). * **projectSettings** (optional): [ProjectSettings object](/api/smartsheet/openapi/schemas/projectsettings), containing at least one of the **projectSettings** attributes, for updating this sheet's project settings and dependencies. * **userSettings** (optional): [SheetUserSettings object](/api/smartsheet/openapi/schemas/sheetusersettings) for updating these user's settings for the sheet. NOTE: * Attributes not specified in **projectSettings** are not updated. * If **projectSettings.nonWorkingDays** is specified as an empty array, all non-working days are removed from the project sheet. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `access_api_level` | string | No | Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Summary Fields **Slug:** `SMARTSHEET_UPDATE_SUMMARY_FIELDS` Updates summary fields on a sheet. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | array | Yes | Summary fields to update. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `rename_if_conflict` | boolean | No | Rename duplicate field titles to make them unique. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Update Request **Slug:** `SMARTSHEET_UPDATE_UPDATE_REQUEST` Changes an update request that still has a future scheduled delivery. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | Yes | Update request attributes to change. | | `sheet_id` | string | Yes | ID of the sheet being accessed. | | `update_request_id` | string | Yes | ID of the update request. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update User **Slug:** `SMARTSHEET_UPDATE_USER` Update user attributes. Requires System Admin permission; modifying a user-model organization member also requires membership in that organization. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | User attributes to update. | | `user_id` | integer | Yes | ID of the user to update. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update User Profile Image **Slug:** `SMARTSHEET_UPDATE_USER_PROFILE_IMAGE` Upload a GIF, JPG, or PNG profile image using the provider's binary, multipart, or JSON URL form. Smartsheet scales images larger than 1050 by 1050 pixels unless a custom size applies. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `file` | object | No | GIF, JPG, or PNG file for binary or multipart upload. | | `user_id` | integer | Yes | ID of the user whose profile image to update. | | `json_body` | object | No | URL attachment request used only with application/json mode. | | `upload_mode` | string ("application/octet-stream" | "multipart/form-data" | "application/json") | Yes | Request media type. Supply only the inputs required by the selected mode. | | `multipart_fields` | object | No | Non-file multipart fields used only with multipart/form-data mode. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Webhook **Slug:** `SMARTSHEET_UPDATE_WEBHOOK` Updates a webhook owned by the connected API-token user. Requires a personal API access token because OAuth administration is app-wide. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Mutable webhook fields to update. | | `webhook_id` | string | Yes | ID of the webhook to update. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Workspace **Slug:** `SMARTSHEET_UPDATE_WORKSPACE` Updates a Smartsheet workspace. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Workspace fields to update. | | `workspace_id` | string | Yes | ID of the workspace to update. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Upgrade User **Slug:** `SMARTSHEET_UPGRADE_USER` Irreversibly upgrade a user's seat in a specified plan. GUEST is valid only for external users. Requires System Admin permission. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | object | No | Seat type upgrade request; defaults to MEMBER when supplied without seatType. | | `plan_id` | integer | Yes | Plan ID in which to upgrade the user's seat. | | `user_id` | integer | Yes | ID of the user to upgrade. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |