Skip to main content
Smartsheet logo
  • Category: project management
  • Auth: OAUTH2, BEARER_TOKEN
  • Composio-managed OAuth available? No
  • Tools: 185
  • Triggers: 0
  • Slug: SMARTSHEET
  • Version: 20261101_00

Tools

Slug: SMARTSHEET_ADD_ALTERNATE_EMAILSAdd 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

string
One alternate email object or an array of alternate email objects.
integer
required
ID of the user receiving the alternate emails.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_ADD_ATTACHMENT_VERSIONUpload 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

object
required
New attachment version to upload. Smartsheet limits files to 30 MB.
integer
required
ID of the sheet being accessed.
string ("application/octet-stream" | "multipart/form-data")
required
Request media type for the new file version.
string
required
ID of the attachment receiving a new version.
object
Optional non-file fields used only with multipart/form-data mode; the file is sent in the file part.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_ADD_CELL_IMAGEUpload image bytes to a specific Smartsheet cell using the binary file marker contract.

Input Parameters

object
required
Image file whose bytes are uploaded directly to the cell.
string
required
ID of the row containing the cell.
string
Alternate text for the image.
string
required
ID of the sheet containing the cell.
string
required
ID of the column containing the cell.
string
Binary request media type used for the image upload.
boolean
Allow the image despite cell validation limits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_ADD_COLUMNSInserts one or more columns into a sheet.

Input Parameters

string
One column or an array of columns to create. Multiple columns must use the same index.
string
required
ID of the sheet being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_ADD_FAVORITESAdds one or more items to the user’s Smartsheet favorites.

Input Parameters

string
required
One favorite or a list of favorites to add.
string
ID of the user on whose behalf the request is made.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_ADD_GROUPCreates a new organization group. Requires group administrator or system administrator access.

Input Parameters

object
Group to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_ADD_GROUP_MEMBERSAdds one or more members to a group asynchronously. Requires group administrator or system administrator access.

Input Parameters

string
One member or an array of members to add. Use primary email addresses.
string
required
ID of the group to add members to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_ADD_REPORT_COLUMNSAdd columns to a report.

Input Parameters

array
Report columns to add, at most 400.
string
required
ID of the report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_ADD_REPORT_SCOPEAdd source sheets to a report by sheet or parent workspace.

Input Parameters

array
Sheets or workspaces to add, at most 100.
string
required
ID of the report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_ADD_ROWSInsert one row or a batch of up to 500 rows, preserving Smartsheet location specifiers for top, bottom, parent, and sibling placement.

Input Parameters

string
One row or an array of up to 500 rows. All rows in a batch must use the same location specifiers.
string
required
ID of the sheet receiving the rows.
string
Access API level; use 1 to permit COMMENTER semantics.
boolean
Allow values outside column validation limits.
boolean
Allow valid rows to succeed when others fail.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_ADD_SUMMARY_FIELD_IMAGEUploads raw image bytes to a sheet summary field.

Input Parameters

object
required
Image file whose bytes are sent as the request body.
string
Alternate text for the image.
string
required
ID of the sheet summary field being accessed.
string
required
ID of the sheet being accessed.
string
Request media type; this operation uses a raw binary body.
boolean
Allow a value outside field validation limits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_ADD_SUMMARY_FIELDSCreates one or more summary fields on a sheet.

Input Parameters

array
required
Summary fields to create.
string
required
ID of the sheet being accessed.
boolean
Rename duplicate field titles to make them unique.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_ADD_USERAdd a user to the organization account. Requires a qualifying paid plan and System Admin permission.

Input Parameters

object
User attributes to create.
boolean
Notify the new user by email. At most 1000 emails may be sent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_ATTACH_TO_COMMENTAttach 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

object
File to upload in binary or multipart mode. Smartsheet limits files to 30 MB.
integer
required
ID of the sheet being accessed.
object
URL attachment request used only with application/json mode.
string
required
ID of the comment receiving the attachment.
string ("application/octet-stream" | "multipart/form-data" | "application/json")
required
Request media type. Choose binary or multipart for a file, or JSON for a URL attachment.
object
Optional non-file fields used only with multipart/form-data mode; the file is sent in the file part.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_ATTACH_TO_PROOFAttaches 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

object
required
File to attach to the proof. Smartsheet limits the file to 30 MB.
string
required
ID of the original proof.
string
required
ID of the sheet being accessed.
string
Request media type; this operation accepts application/octet-stream only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_ATTACH_TO_ROWAttach 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

object
File to upload in binary or multipart mode. Smartsheet limits files to 30 MB.
integer
required
ID of the row receiving the attachment.
integer
required
ID of the sheet being accessed.
object
URL attachment request used only with application/json mode.
string ("application/octet-stream" | "multipart/form-data" | "application/json")
required
Request media type. Choose binary or multipart for a file, or JSON for a URL attachment.
object
Optional non-file fields used only with multipart/form-data mode; the file is sent in the file part.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_ATTACH_TO_SHEETAttach 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

object
File to upload in binary or multipart mode. Smartsheet limits files to 30 MB.
integer
required
ID of the sheet receiving the attachment.
object
URL attachment request used only with application/json mode.
string ("application/octet-stream" | "multipart/form-data" | "application/json")
required
Request media type. Choose binary or multipart for a file, or JSON for a URL attachment.
object
Optional non-file fields used only with multipart/form-data mode; the file is sent in the file part.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_CHECK_FAVORITEChecks whether a specific Smartsheet item is a favorite.

Input Parameters

string ("directId" | "name")
Optional favorite detail to include.
string
required
ID of the item to check.
string ("folder" | "report" | "sheet" | "sight" | "template" | "workspace")
required
Favorite type.
string
ID of the user on whose behalf the request is made.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_COPY_DASHBOARDCreates a copy of a specified Smartsheet dashboard.

Input Parameters

object
Destination and optional new name for the copy.
string
required
ID of the dashboard to copy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_COPY_FOLDERCopies a Smartsheet folder. Cell history is not copied.

Input Parameters

object
required
New folder destination specification.
string
Set to sheetHyperlinks to exclude sheet hyperlinks.
array
Comma-separated element categories to copy.
string
required
ID of the folder to copy.
array
Comma-separated references not to remap in the copied folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_COPY_ROWS_TO_ANOTHER_SHEETCopy selected rows to the bottom of another Smartsheet sheet.

Input Parameters

object
Source row IDs and destination sheet.
string ("all" | "attachments" | "children" | "discussions")
Additional row elements to copy.
string
required
ID of the source sheet.
boolean
Ignore source row IDs that do not exist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_COPY_SHEETCreates a copy of the specified sheet.

Input Parameters

object
required
Destination where to create a copy of the specified sheet.
string
When specified with a value of sheetHyperlinks, excludes this category from the response
array
Elements to copy. ruleRecipients requires rules. Cell history is not copied.
string
required
ID of the sheet being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_COPY_WORKSPACECopies a Smartsheet workspace. Cell history is not copied.

Input Parameters

object
required
Copied-workspace settings.
array
Element to include in the copy. Cell history is never copied.
array
Reference type not to remap in the copied workspace.
string
required
ID of the workspace to copy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_CREATE_CROSS_SHEET_REFERENCESCreates a cross-sheet reference and defines its source range.

Input Parameters

object
required
Cross-sheet reference and its source range.
string
required
ID of the destination sheet being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_CREATE_DISCUSSION_COMMENTAdds a comment to a discussion using JSON or multipart upload.

Input Parameters

object
File to attach in multipart mode. Smartsheet allows files up to 30 MB.
string
required
ID of the sheet containing the discussion.
object
Comment request used only with application/json mode.
string ("application/json" | "multipart/form-data")
required
Request media type. Supply only the inputs required by the selected mode.
string
required
ID of the discussion to comment on.
object
Non-file fields used only with multipart/form-data mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_CREATE_FOLDER_IN_FOLDERCreates a new folder inside an existing Smartsheet folder.

Input Parameters

object
required
Folder to create.
string
required
ID of the parent folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_CREATE_FOLDER_IN_HOMECreates a folder in Home. This Smartsheet endpoint is deprecated.

Input Parameters

object
required
Folder to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_CREATE_FOLDER_IN_WORKSPACECreates a new folder at the top level of a Smartsheet workspace.

Input Parameters

object
required
Folder to create.
string
required
ID of the workspace where the folder will be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_CREATE_PROOFCreates a proof on a row from an uploaded file, using the file’s MIME type for the upload.

Input Parameters

object
required
File whose bytes become the new proof.
string
required
ID of the sheet row receiving the proof.
string
required
ID of the sheet being accessed.
string
Request media type; this operation accepts application/octet-stream only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_CREATE_PROOF_DISCUSSIONCreates a discussion on a proof using exactly application/json or multipart/form-data.

Input Parameters

object
File to attach in multipart mode. Smartsheet limits files to 30 MB.
string
required
ID of the original proof.
string
required
ID of the sheet being accessed.
object
Discussion body used only with application/json mode.
string ("application/json" | "multipart/form-data")
required
Exact request media type; supply only the matching input contract.
object
Non-file fields used only with multipart/form-data mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_CREATE_PROOF_REQUESTCreates and sends a proof request. Sending the request is an irreversible external effect.

Input Parameters

object
Proof request email and download settings.
string
required
ID of the original proof.
string
required
ID of the sheet being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_CREATE_PROOF_VERSIONCreates a proof version from a binary file upload.

Input Parameters

object
required
File bytes for the new proof version.
string
required
ID of the original proof.
string
required
ID of the sheet being accessed.
string
Request media type; proof versions support binary upload only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_CREATE_REPORTCreate a report from a scope, columns, definition, and destination.

Input Parameters

object
Report to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_CREATE_ROW_DISCUSSIONCreates a discussion on a row using JSON or multipart upload.

Input Parameters

object
File to attach in multipart mode. Smartsheet allows files up to 30 MB.
string
required
ID of the row on which to create the discussion.
string
required
ID of the sheet containing the row.
object
Discussion request used only with application/json mode.
string ("application/json" | "multipart/form-data")
required
Request media type. Supply only the inputs required by the selected mode.
object
Non-file fields used only with multipart/form-data mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_CREATE_SHEET_DISCUSSIONCreates a discussion on a sheet using JSON or multipart upload.

Input Parameters

object
File to attach in multipart mode. Smartsheet allows files up to 30 MB.
string
required
ID of the sheet on which to create the discussion.
object
Discussion request used only with application/json mode.
string ("application/json" | "multipart/form-data")
required
Request media type. Supply only the inputs required by the selected mode.
object
Non-file fields used only with multipart/form-data mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_CREATE_SHEET_IN_FOLDERCreates a sheet from scratch or from the specified template in the specified folder.

Input Parameters

object
required
Sheet to create.
array
Additional parameter to create a sheet from template. A comma-separated list of elements to copy from the template.
string
required
ID of the folder being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_CREATE_SHEET_IN_SHEETS_FOLDERCreates 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

object
required
Sheet to create.
array
Additional parameter to create a sheet from template. A comma-separated list of elements to copy from the template.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_CREATE_SHEET_IN_WORKSPACECreates a sheet from scratch or from the specified template at the top-level of the specified workspace.

Input Parameters

object
required
An object which defines the sheet to create.
array
Additional parameter to create a sheet from template. A comma-separated list of elements to copy from the template.
string
required
ID of the workspace being accessed.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_CREATE_UPDATE_REQUESTCreates an update request and sends or schedules its email notification. This has an irreversible external effect.

Input Parameters

object
Update request email, rows, columns, and optional schedule.
string
required
ID of the sheet being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_CREATE_WEBHOOKCreates an inactive webhook owned by the connected API-token user. Requires a personal API access token; activate it later with Update Webhook.

Input Parameters

object
Webhook definition to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_CREATE_WORKSPACECreates a new Smartsheet workspace.

Input Parameters

object
required
Workspace to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DEACTIVATE_USERDeactivate 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

integer
required
ID of the user to deactivate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_ALTERNATE_EMAILDelete an alternate email. Available only to System Admins on Enterprise or Advanced Work Management plans with the feature activated by Support.

Input Parameters

integer
required
ID of the user whose alternate email to delete.
integer
required
ID of the alternate email to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_ASSET_SHAREDeletes a share for a Smartsheet asset.

Input Parameters

string
required
Numeric or string ID of the asset.
string
required
Unique ID of the share.
string ("sheet" | "report" | "sight" | "workspace" | "collection" | "file")
required
Type of asset containing the share.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_ATTACHMENTDelete an attachment from a Smartsheet sheet.

Input Parameters

integer
required
ID of the sheet being accessed.
string
required
ID of the attachment to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_ATTACHMENT_VERSIONSDelete every version of an attachment, effectively removing a multi-version attachment from its parent object.

Input Parameters

integer
required
ID of the sheet being accessed.
string
required
ID of the attachment whose versions to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_AUTOMATION_RULEDeletes an automation rule from a sheet.

Input Parameters

string
required
ID of the sheet being accessed.
string
required
ID of the automation rule being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_COLUMNDeletes a column from a sheet.

Input Parameters

string
required
ID of the sheet being accessed.
string
required
ID of the sheet column being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_COMMENTDeletes the specified comment.

Input Parameters

string
required
ID of the sheet containing the comment.
string
required
ID of the comment to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_DASHBOARDDeletes a specified Smartsheet dashboard.

Input Parameters

string
required
ID of the dashboard to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_DISCUSSIONDeletes the specified discussion.

Input Parameters

string
required
ID of the sheet containing the discussion.
string
required
ID of the discussion to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_FAVORITERemoves one item from the user’s Smartsheet favorites.

Input Parameters

string
required
ID of the favorited sheet, report, folder, dashboard, template, or workspace.
string ("folder" | "report" | "sheet" | "sight" | "template" | "workspace")
required
Favorite type.
string
ID of the user on whose behalf the request is made.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_FOLDERDeletes a Smartsheet folder.

Input Parameters

string
required
ID of the folder to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_GROUPDeletes a group asynchronously. Members may briefly retain sharing access after the call returns.

Input Parameters

string
required
ID of the group to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_GROUP_MEMBERSRemoves a member from a group asynchronously. Requires group administrator or system administrator access.

Input Parameters

string
required
ID of the user to remove from the group.
string
required
ID of the group to remove the member from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_MULTIPLE_FAVORITESRemoves multiple favorites of one type.

Input Parameters

string
required
Comma-separated IDs of the favorited items to remove.
string ("folder" | "report" | "sheet" | "sight" | "template" | "workspace")
required
Type of the favorited items to remove.
string
ID of the user on whose behalf the request is made.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_PROOFDeletes an original proof and all its versions.

Input Parameters

string
required
ID of the original proof to delete with all versions.
string
required
ID of the sheet being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_PROOF_REQUESTSDeletes all requests in a proof.

Input Parameters

string
required
ID of the original proof whose requests will be deleted.
string
required
ID of the sheet being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_PROOF_VERSIONDeletes the current proof version identified by proof ID.

Input Parameters

string
required
ID of the current proof version to delete.
string
required
ID of the sheet being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_REPORTDelete a report by ID.

Input Parameters

string
required
ID of the report to delete.
string
Set to 1 to enable COMMENTER access behavior; 0 uses VIEWER behavior.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_REPORT_COLUMNDelete a column from a report.

Input Parameters

string
required
ID of the report.
string
required
Virtual ID of the report column to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_ROWSDelete one or more rows from a Smartsheet sheet.

Input Parameters

string
required
Comma-separated row IDs to delete.
string
required
ID of the sheet containing the rows.
boolean
If true, ignore missing row IDs; otherwise one missing row prevents all deletions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_SENT_UPDATE_REQUESTDeletes a sent update request only while it is pending; completed requests cannot be deleted.

Input Parameters

string
required
ID of the sheet being accessed.
string
required
ID of the pending sent update request to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_SHEETDeletes the sheet specified in the URL.

Input Parameters

string
required
ID of the sheet being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_SUMMARY_FIELDSDeletes one or more summary fields from a sheet.

Input Parameters

string
required
Comma-separated sheet summary field IDs to delete.
string
required
ID of the sheet being accessed.
boolean
Succeed when some requested field IDs do not exist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_UPDATE_REQUESTTerminates future scheduled delivery of an update request.

Input Parameters

string
required
ID of the sheet being accessed.
string
required
ID of the future scheduled update request to terminate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_WEBHOOKPermanently deletes a webhook owned by the connected API-token user. Requires a personal API access token; disable temporarily with Update Webhook instead.

Input Parameters

string
required
ID of the webhook to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DELETE_WORKSPACEPermanently deletes a Smartsheet workspace.

Input Parameters

string
required
ID of the workspace to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_DOWNGRADE_USERIrreversibly downgrade a user’s seat in a specified plan. GUEST is valid only for external users. Requires System Admin permission.

Input Parameters

object
Seat type downgrade request.
integer
required
Plan ID in which to downgrade the user’s seat.
integer
required
ID of the user to downgrade.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_EDIT_COMMENTUpdates comment text. Only the user who created a comment may update it.

Input Parameters

object
Updated comment text.
string
required
ID of the sheet containing the comment.
string
required
ID of the comment to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_ALTERNATE_EMAILGet one alternate email. Available only to System Admins on Enterprise or Advanced Work Management plans with the feature activated by Support.

Input Parameters

integer
required
ID of the user whose alternate email to retrieve.
integer
required
ID of the alternate email to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_ASSET_SHARERetrieves a specific share for a Smartsheet asset.

Input Parameters

string
required
Numeric or string ID of the asset.
string
required
Unique ID of the share.
string ("sheet" | "report" | "sight" | "workspace" | "collection" | "file")
required
Type of asset containing the share.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_ATTACHMENTFetch attachment metadata and, for files, a temporary download URL and its lifetime.

Input Parameters

integer
required
ID of the sheet being accessed.
string
required
ID of the attachment to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_AUTOMATION_RULEReturns an automation rule, including its action values.

Input Parameters

string
required
ID of the sheet being accessed.
string
required
ID of the automation rule being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_COLUMNGets the definition of a sheet column.

Input Parameters

integer
Complex column compatibility level: 0, 1, or 2.
string
required
ID of the sheet being accessed.
string
required
ID of the sheet column being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_COMMENTGets the comment specified by comment ID.

Input Parameters

string
required
ID of the sheet containing the comment.
string
required
ID of the comment to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_CONTACTGet a specified Smartsheet contact by contact ID.

Input Parameters

string
Set to profileImage to include the contact’s profile image.
string
required
Opaque ID of the contact to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_CROSS_SHEET_REFERENCEGets a cross-sheet reference by ID.

Input Parameters

string
required
ID of the sheet being accessed.
string
required
ID of the cross-sheet reference being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_CURRENT_USERGet the connected Smartsheet user’s profile. OAuth permits this identity operation without a dedicated scope.

Input Parameters

string
Set to groups to include groups the current user belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_DASHBOARDGets a specified Smartsheet dashboard and its widgets.

Input Parameters

integer
Compatibility level: 0 text, 2 multi-contact, 3 multi-picklist, or 4 metric summary data.
string ("objectValue" | "source")
Optional objectValue or source details to include.
string
required
ID of the dashboard to retrieve.
boolean
Use Unix epoch milliseconds for date-time values.
string
Set to 1 to enable COMMENTER access; 0 uses VIEWER-compatible behavior.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_DASHBOARD_PATHGets the hierarchical folder and workspace path of a dashboard.

Input Parameters

string
required
ID of the dashboard whose path to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_DASHBOARD_PUBLISH_STATUSGets the publish settings for a Smartsheet dashboard.

Input Parameters

string
required
ID of the dashboard whose publish settings to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_DISCUSSIONGets the discussion specified by discussion ID.

Input Parameters

string
required
ID of the sheet containing the discussion.
string
required
ID of the discussion to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_FOLDER_METADATAGets the metadata of a Smartsheet folder.

Input Parameters

string
Include the source object when available.
integer
required
ID of the folder.
boolean
Return dates as Unix epoch milliseconds instead of ISO-8601 strings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_FOLDER_PATHGets the hierarchical path of a folder within its workspace.

Input Parameters

string
required
ID of the folder.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_GROUPGets a group and its members.

Input Parameters

string
required
ID of the group to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_IMAGE_URLSGenerate temporary read URLs for specified Smartsheet cell images. The returned URLs expire after the reported lifetime.

Input Parameters

array
Cell images for which to generate temporary read URLs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_PROOFGets a proof, optionally including attachments or discussions.

Input Parameters

string ("attachments" | "discussions")
Optional proof content to include: attachments or discussions.
string
required
ID of the original proof.
string
required
ID of the sheet being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_REPORTGet one report as a paged JSON object or an offloaded Excel or CSV file.

Input Parameters

integer
Provider page number; cursor takes precedence when supplied.
integer
Compatibility level: 0, 1, or 3.
string
Continuation cursor returned by a previous JSON call. Omit for the first page.
string ("linkInFromCellDetails" | "linksOutToCellsDetails")
Optional report element to exclude.
string ("attachments" | "discussions" | "proofs" | "format" | "objectValue" | "scope" | "source" | "sourceSheets")
Optional report element to include.
integer
Maximum report rows on this page, from 1 through 10,000.
string
required
ID of the report.
string ("json" | "excel" | "csv")
Response representation. Exports are offloaded as downloadable files.
string
Set to 1 to enable COMMENTER access behavior; 0 uses VIEWER behavior.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_REPORT_COLUMNGet one report column by its virtual ID.

Input Parameters

integer
Compatibility level: 0 for text, 1 for multi-contact, or 3 for multi-picklist data.
string
required
ID of the report.
string
required
Virtual ID of the report column.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_REPORT_DEFINITIONGet a report’s filters, grouping, summarizing, and sorting definition.

Input Parameters

string
required
ID of the report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_REPORT_PATHGet the report’s hierarchical folder and workspace path.

Input Parameters

string
required
ID of the report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_REPORT_PUBLISH_STATUSGet a report’s publishing settings.

Input Parameters

string
required
ID of the report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_ROWGet a Smartsheet row by sheet and row ID, with optional related row data.

Input Parameters

integer
Object-value compatibility level from 0 to 2.
string
required
ID of the row to retrieve.
string ("filteredOutRows" | "linkInFromCellDetails" | "linksOutToCellsDetails" | "nonexistentCells")
Optional row elements to exclude.
string ("attachments" | "columns" | "columnType" | "discussions" | "filters" | "format" | "objectValue" | "proofs" | "rowPermalink" | "writerInfo")
Optional row elements to include.
string
required
ID of the sheet containing the row.
string
Access API level; use 1 to permit COMMENTER semantics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_SENT_UPDATE_REQUESTGets the specified sent update request on the sheet.

Input Parameters

string
required
ID of the sheet being accessed.
string
required
ID of the sent update request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_SERVER_INFOGet Smartsheet application constants, formats, and supported locales.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_SHEETGets a sheet by ID as JSON or as a downloadable PDF, Excel, or CSV export. JSON results use pagination and may include a continuation cursor.

Input Parameters

integer
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.
integer
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.
string
Continuation cursor returned by a previous call. Omit for the first page.
array
Comma-separated element types to exclude from the response.
array
Comma-separated response expansions. Discussion attachments require both attachments and discussions.
string
A comma-separated list of row Ids on which to filter the rows included in the result.
string
required
ID of the sheet being accessed.
string
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.
integer
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.
string
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.
string ("LETTER" | "LEGAL" | "WIDE" | "ARCHD" | "A4" | "A3" | "A2" | "A1" | "A0")
applies to PDF format only
string
A comma-separated list of row numbers on which to filter the rows included in the result. Non-existent row numbers are ignored.
string ("json" | "pdf" | "excel" | "csv")
Response representation. Non-JSON exports are returned as downloadable files with the provider MIME type.
string
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.
integer
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.
string
Filter to return only rows that have been modified since the date/time provided. Date should be in ISO-8601 format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_SHEET_PATHGets the hierarchical path of the sheet, showing its location within folders and workspace, if workspace-level access is provided.

Input Parameters

string
required
ID of the sheet being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_SHEET_PUBLISH_STATUSGets the sheet’s ‘Publish’ settings.

Input Parameters

string
required
ID of the sheet being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_SHEET_SUMMARYReturns all summary fields defined on a sheet, including requested format or writer details.

Input Parameters

string ("displayValue" | "image" | "imageAltText")
Optional summary details to exclude.
string ("format" | "writerInfo")
Optional summary details to include.
string
required
ID of the sheet being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_SHEET_VERSIONGets 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

string
required
ID of the sheet being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_UPDATE_REQUESTGets an update request that has a future delivery schedule.

Input Parameters

string
required
ID of the sheet being accessed.
string
required
ID of the update request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_USERGet a Smartsheet user by ID.

Input Parameters

integer
required
ID of the user to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_WEBHOOKGets a webhook owned by the connected API-token user, including its configured event patterns. Requires a personal API access token.

Input Parameters

string
required
ID of the webhook to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_GET_WORKSPACE_METADATAGets metadata for a specified Smartsheet workspace.

Input Parameters

string
Set to source to include creation-source information when available.
integer
required
ID of the workspace.
boolean
Return date-times as Unix epoch milliseconds instead of ISO-8601 strings.
string
Set to 1 to allow COMMENTER access in inputs and responses; 0 uses the backwards-compatible VIEWER behavior.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_IMPORT_SHEET_FROM_CSV_XLSXImports 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

object
required
File to upload. Required for binary or multipart upload modes that declare a file part.
string
required
Desired name of the sheet.
string ("text/csv" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet")
required
Required file media type: text/csv for CSV or the XLSX media type for Excel workbooks.
string
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.
string
A zero-based integer indicating the column to designate as primary.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_IMPORT_SHEET_INTO_FOLDERImports CSV or XLSX data into a new sheet in the specified folder.

Input Parameters

object
required
File to upload. Required for binary or multipart upload modes that declare a file part.
string
required
ID of the folder being accessed.
string
required
Desired name of the sheet.
string ("text/csv" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet")
required
Required file media type: text/csv for CSV or the XLSX media type for Excel workbooks.
string
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.
string
A zero-based integer indicating the column to designate as primary.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_IMPORT_SHEET_INTO_WORKSPACEImports CSV or XLSX data into a new sheet in the specified workspace.

Input Parameters

object
required
File to upload. Required for binary or multipart upload modes that declare a file part.
string
required
Desired name of the sheet.
string ("text/csv" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet")
required
Required file media type: text/csv for CSV or the XLSX media type for Excel workbooks.
string
required
ID of the workspace being accessed.
string
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.
string
A zero-based integer indicating the column to designate as primary.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_ALTERNATE_EMAILSList 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

integer
required
ID of the user whose alternate emails to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_ASSET_SHARESRetrieves one page of users and groups an asset is shared with and their access levels.

Input Parameters

string
Continuation cursor returned by a previous call. Omit for the first page.
string
required
Numeric or string ID of the asset whose shares to list.
integer
Shares to return on this page (100-1000, in multiples of 100).
string ("sheet" | "report" | "sight" | "workspace" | "collection" | "file")
required
Type of asset whose shares to list.
string ("ITEM" | "WORKSPACE")
Include item-level or workspace-level shares.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_ATTACHMENT_VERSIONSGet one page of an attachment’s versions, ordered from newest to oldest.

Input Parameters

integer
Page number to request.
string
Continuation cursor from a previous call. Omit for the first page.
integer
required
ID of the sheet being accessed.
integer
Maximum attachment versions to return on this page.
boolean
Whether to return all versions without pagination. Do not combine true with page, page_size, or cursor.
string
required
ID of the attachment whose versions to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_AUTOMATION_RULESReturns one page of automation rules associated with a sheet.

Input Parameters

integer
Page number to return.
string
Continuation cursor returned by a previous call.
string
required
ID of the sheet being accessed.
integer
Maximum rules to return per page.
boolean
Return all rules without pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_CELL_HISTORYReturn 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

integer
Page number to request.
integer
Object-value compatibility level from 0 to 2.
string
Continuation cursor from a previous call. Omit for the first page.
string
required
ID of the row containing the cell.
string ("columnType" | "objectValue")
Additional cell history fields to include.
string
required
ID of the sheet containing the cell.
string
required
ID of the column containing the cell.
integer
Maximum history records to return on this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_COLUMNSGets one page of columns belonging to a sheet.

Input Parameters

integer
Page number to return.
integer
Complex column compatibility level: 0, 1, or 2.
string
Continuation cursor returned by a previous call.
string
required
ID of the sheet being accessed.
integer
Maximum columns to return per page.
boolean
Return all columns without pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_CONTACTSLists the connected user’s Smartsheet contacts, with pagination and a continuation cursor when another page is available. It can also request all contacts without pagination.

Input Parameters

integer
Page number to request directly. Defaults to 1.
string
Continuation cursor from a previous call. Omit for the first page.
integer
Maximum number of contacts to return on this page. Defaults to 100.
boolean
Whether to return all contacts without pagination. Do not combine true with page, page_size, or cursor.
boolean
Whether dates are sent and returned as Unix epoch milliseconds.
string
Return contacts modified at or after this ISO 8601 timestamp, or Unix epoch milliseconds when numeric_dates is true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_CROSS_SHEET_REFERENCESLists cross-sheet references for a sheet, with pagination or an option to request all references without pagination.

Input Parameters

integer
Page number to return.
string
Continuation cursor returned by a previous call.
string
required
ID of the sheet being accessed.
integer
Maximum references to return per page.
boolean
Return all references without pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_DASHBOARDSGets one page of dashboards the connected user can access.

Input Parameters

string
Opaque continuation cursor returned by a previous call. Omit for the first page.
integer
Maximum dashboards to return on this page (1-1000).
boolean
Use Unix epoch milliseconds for date-time values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_DISCUSSION_ATTACHMENTSGet one page of attachments in a Smartsheet discussion.

Input Parameters

integer
Page number to request.
string
Continuation cursor from a previous call. Omit for the first page.
integer
required
ID of the sheet being accessed.
integer
Maximum attachments to return on this page.
boolean
Whether to return all attachments without pagination. Do not combine true with page, page_size, or cursor.
string
required
ID of the discussion whose attachments to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_EVENTSFetch Smartsheet organization events for a System Admin. Requires the Event Reporting premium add-on.

Input Parameters

string
Latest event time in ISO 8601 format; requires since.
string
Earliest event time in ISO 8601 format. Supply exactly one of since or stream_position.
integer
Maximum events to return, from 1 through 10,000.
boolean
Whether dates are sent and returned as Unix epoch milliseconds.
string ("deflate" | "gzip")
Optional response compression encoding: deflate or gzip.
string
Managed plan whose events to list, when authorized.
string
nextStreamPosition from a previous response. Use instead of since.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_FAVORITESGets the user’s favorites, with pagination and a continuation cursor when more results are available. It also supports requesting all results without pagination.

Input Parameters

integer
Page number to return.
string
Continuation cursor returned by a previous call. Omit for the first page.
string ("directId" | "name")
Optional favorite detail to include.
integer
Maximum number of favorites to return per page.
boolean
If true, return all results without pagination.
string
ID of the user on whose behalf the request is made.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_FILTERED_EVENTSFetch events related to selected Smartsheet sheets and workspaces for a non-admin user. Requires the Event Reporting premium add-on.

Input Parameters

object
Documented Smartsheet event filter body.
string ("deflate" | "gzip")
Optional response compression encoding: deflate or gzip.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_FOLDER_CHILDRENReturns one page of immediate resources inside a Smartsheet folder.

Input Parameters

string
Continuation cursor returned by a previous call. Omit for the first page.
array
Comma-separated child metadata to include.
integer
required
ID of the folder.
integer
Items per page (100-1000, in multiples of 100).
boolean
Return dates as Unix epoch milliseconds instead of ISO-8601 strings.
string
Access API level; use 1 to include COMMENTER access.
array
Comma-separated child resource types to include.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_FOLDERS_IN_HOMELists folders in the Sheets folder. This Smartsheet endpoint is deprecated.

Input Parameters

integer
Page number to return.
string
Continuation cursor returned by a previous call. Omit for the first page.
integer
Maximum number of folders to return per page.
boolean
If true, return all results without pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_HOME_CONTENTSGets all Home objects shared to the user. This Smartsheet endpoint is deprecated.

Input Parameters

string ("source" | "distributionLink" | "ownerInfo" | "sheetVersion")
Comma-separated optional elements to include in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_ORG_GROUPSGets one page of all groups in an organization account, with a continuation cursor.

Input Parameters

integer
Page number to return.
string
Continuation cursor returned by a previous call. Omit for the first page.
integer
Maximum number of groups to return on this page.
boolean
Return all groups without pagination.
boolean
Use Unix epoch milliseconds for date-time values.
string
Return groups modified at or after this ISO-8601 timestamp or Unix epoch value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_ORG_SHEETSGets 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

string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_PROOF_ATTACHMENTSGets one page of non-discussion attachments in a proof.

Input Parameters

integer
Page number to return.
string
Continuation cursor from a previous call. Omit for the first page.
string
required
ID of the original proof.
string
required
ID of the sheet being accessed.
integer
Maximum attachments to return on this page.
boolean
Return all results without pagination; do not combine true with page, page_size, or cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_PROOF_DISCUSSIONSGets one page of discussions in a proof.

Input Parameters

integer
Page number to return.
string
Continuation cursor from a previous call. Omit for the first page.
string ("attachments" | "comments")
Optional content to include; attachments is effective only when comments is also requested.
string
required
ID of the original proof.
string
required
ID of the sheet being accessed.
integer
Maximum discussions to return on this page.
boolean
Return all results without pagination; do not combine true with page, page_size, or cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_PROOF_REQUEST_ACTIONSGets one page of summarized request actions for a proof.

Input Parameters

integer
Page number to return.
string
Continuation cursor from a previous call. Omit for the first page.
string
required
ID of the original proof.
string
required
ID of the sheet being accessed.
integer
Maximum actions to return on this page.
boolean
Return all results without pagination; do not combine true with page, page_size, or cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_PROOFSGets one page of proofs for a sheet.

Input Parameters

integer
Page number to return.
string
Continuation cursor from a previous call. Omit for the first page.
string
required
ID of the sheet being accessed.
integer
Maximum proofs to return on this page.
boolean
Return all results without pagination; do not combine true with page, page_size, or cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_PROOF_VERSIONSGets one page of proof versions from newest to oldest.

Input Parameters

integer
Page number to return.
string
Continuation cursor from a previous call. Omit for the first page.
string
required
ID of the original proof.
string
required
ID of the sheet being accessed.
integer
Maximum versions to return on this page.
boolean
Return all results without pagination; do not combine true with page, page_size, or cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_REPORT_COLUMNSList one page of columns for a report.

Input Parameters

integer
Compatibility level: 0, 1, or 3.
string
Continuation cursor returned by a previous call. Omit for the first page.
integer
Maximum columns on this page, from 100 through 1000 in increments of 100.
string
required
ID of the report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_REPORTSList a page of reports accessible to the connected user, optionally filtered by modification time.

Input Parameters

string
Only return reports modified on or after this ISO 8601 timestamp or epoch value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_REPORT_SCOPEList one page of source sheets and workspaces in a report’s scope.

Input Parameters

string
Continuation cursor returned by a previous call. Omit for the first page.
integer
Maximum scope entries on this page, from 100 through 1000 in increments of 100.
string
required
ID of the report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_ROW_ATTACHMENTSGet one page of row- and row-discussion-level attachments on a Smartsheet row.

Input Parameters

integer
Page number to request.
string
Continuation cursor from a previous call. Omit for the first page.
integer
required
ID of the row whose attachments to list.
integer
required
ID of the sheet being accessed.
integer
Maximum attachments to return on this page.
boolean
Whether to return all attachments without pagination. Do not combine true with page, page_size, or cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_ROW_DISCUSSIONSGets one page of discussions associated with a row.

Input Parameters

integer
Page number to request.
string
Continuation cursor returned by a previous call. Omit for the first page.
string
required
ID of the row whose discussions to list.
string ("attachments" | "comments")
Optional discussion elements to include.
string
required
ID of the sheet containing the row.
integer
Maximum discussions to return on this page.
boolean
Return all results without pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_SENT_UPDATE_REQUESTSLists summarized sent update requests on the sheet. Returns one page and a continuation cursor.

Input Parameters

integer
Page number to return.
string
Continuation cursor from a previous call. Omit for the first page.
string
required
ID of the sheet being accessed.
integer
Maximum number of sent requests on this page.
boolean
Return all results without pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_SHEET_ATTACHMENTSGet one page of sheet-, row-, and discussion-level attachments on a sheet.

Input Parameters

integer
Page number to request.
string
Continuation cursor from a previous call. Omit for the first page.
integer
required
ID of the sheet whose attachments to list.
integer
Maximum attachments to return on this page.
boolean
Whether to return all attachments without pagination. Do not combine true with page, page_size, or cursor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_SHEET_DISCUSSIONSGets one page of discussions associated with a sheet.

Input Parameters

integer
Page number to request.
string
Continuation cursor returned by a previous call. Omit for the first page.
string ("attachments" | "comments")
Optional discussion elements to include.
string
required
ID of the sheet whose discussions to list.
integer
Maximum discussions to return on this page.
boolean
Return all results without pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_SHEETSGets 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

integer
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.
string
Continuation cursor returned by a previous call. Omit for the first page.
string ("sheetVersion" | "source")
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
integer
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.
boolean
If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified).
boolean
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.
string
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.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_SUMMARY_FIELDSReturns one page of sheet summary fields and a continuation cursor.

Input Parameters

integer
Page number to return.
string
Continuation cursor from a previous call. Omit for the first page.
string ("displayValue" | "image" | "imageAltText")
Optional summary details to exclude.
string ("format" | "writerInfo")
Optional summary details to include.
string
required
ID of the sheet being accessed.
integer
Maximum summary fields on this page.
boolean
Return all fields without pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_UPDATE_REQUESTSLists update requests with future schedules for a sheet, either paginated with a continuation cursor when available or with all results requested at once.

Input Parameters

integer
Page number to return.
string
Continuation cursor from a previous call. Omit for the first page.
string
required
ID of the sheet being accessed.
integer
Maximum update requests on this page.
boolean
Return all results without pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_USER_PLANSList one token-paginated page of plans to which a user belongs.

Input Parameters

string
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.
string
Set to planName to include the owning organization name.
integer
required
ID of the user whose plans to list.
integer
Maximum plans to return, from 100 to 1000 in increments of 100.
boolean
Display CONTRIBUTOR for free-tier plan seats.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_USERSList organization users with optional email, plan, and seat filters. Organization directory access can require a qualifying plan and System Admin role.

Input Parameters

integer
Page number to return; defaults to 1.
string
Comma-separated email addresses to filter by.
string
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.
string
Set to lastLogin to include eligible users’ last login time.
integer
Plan ID whose user seat types should be returned. System Admin only.
integer
Maximum users per page; defaults to 100.
string ("MEMBER" | "PROVISIONAL_MEMBER" | "GUEST" | "CONTRIBUTOR" | "VIEWER")
Filter by seat type. System Admin only; VIEWER is deprecated.
boolean
Return all users without pagination.
boolean
Return dates as milliseconds since the Unix epoch.
boolean
Display CONTRIBUTOR for users with a free-tier seat when no seat type filter is set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_WEBHOOKSGets 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

integer
Provider page number for the first request; cursor takes precedence when supplied.
string
Continuation cursor returned by a previous call. Omit for the first page.
integer
Webhooks to return on this page (1-10,000).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_WORKSPACE_CHILDRENRetrieves one page of immediate child resources from a specified Smartsheet workspace.

Input Parameters

string
Continuation cursor returned by a previous call. Omit for the first page.
array
Comma-separated response expansions: source creation details and owner information.
integer
Maximum child resources to return (100-1000, in multiples of 100).
integer
required
ID of the workspace.
boolean
Return date-times as Unix epoch milliseconds instead of ISO-8601 strings.
string
Set to 1 to allow COMMENTER access in inputs and responses; 0 uses the backwards-compatible VIEWER behavior.
array
Comma-separated child types to include. Include sheets whenever templates is requested.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_LIST_WORKSPACESRetrieves one page of workspace metadata for workspaces the connected user can access.

Input Parameters

string
Continuation cursor returned by a previous call. Omit for the first page.
integer
Maximum workspaces to return on this page (100-1000).
string
Set to 1 to allow COMMENTER access in inputs and responses; 0 uses the backwards-compatible VIEWER behavior.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_MAKE_ALTERNATE_EMAIL_PRIMARYMake 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

integer
required
ID of the user whose primary email to change.
integer
required
ID of the alternate email to make primary.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_MOVE_DASHBOARDMoves a specified Smartsheet dashboard to another container.

Input Parameters

object
Destination for the dashboard.
string
required
ID of the dashboard to move.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_MOVE_FOLDERMoves a Smartsheet folder to another container.

Input Parameters

object
required
New folder destination.
string
required
ID of the folder to move.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_MOVE_ROWS_TO_ANOTHER_SHEETMove selected rows to the bottom of another Smartsheet sheet.

Input Parameters

object
Source row IDs and destination sheet.
string ("attachments" | "discussions")
Additional row elements to move.
string
required
ID of the source sheet.
boolean
Ignore source row IDs that do not exist.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_MOVE_SHEETMoves the specified sheet to a new location.

Input Parameters

object
required
Destination to move the specified sheet.
string
required
ID of the sheet being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_REACTIVATE_USERReactivate 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

integer
required
ID of the user to reactivate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_REMOVE_REPORT_SCOPERemove source sheets from a report by sheet or parent workspace.

Input Parameters

array
Sheets or workspaces to remove, at most 100.
string
required
ID of the report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_REMOVE_USER_FROM_ORGANIZATIONRemove 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

integer
required
ID of the user to remove.
integer
Qualified Group Admin user ID that receives owned groups and, when requested, assets.
boolean
Transfer all owned assets and groups to transfer_to.
boolean
Remove the user’s access to all organization and plan assets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_REMOVE_USER_FROM_PLANDeactivate 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

integer
required
Plan ID from which to remove the user.
integer
required
ID of the user to remove from the plan.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_RESET_WEBHOOK_SHARED_SECRETIrreversibly rotates a webhook secret owned by the connected API-token user after explicit confirmation. Requires a personal API access token.

Input Parameters

string
required
ID of the webhook whose shared secret will be rotated.
boolean
required
Must be true to confirm that the current shared secret will immediately stop working.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_SEARCH_EVERYTHINGSearches all sheets that the user can access, for the specified text.

Input Parameters

string
required
Text with which to perform the search. Tip: To match the exact text, wrap the query in double-quotes.
array
If search fails, try using an array for each type of this comma-separated list of search filters.
string
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
string
Deprecated When specified with a value of personalWorkspace, limits the response to only those items in the user’s workspaces.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_SEARCH_SHEETGets a list of the user’s search results in a sheet, based on a query.

Input Parameters

string
required
Text with which to perform the search. Tip: To match the exact text, wrap the query in double-quotes.
string
required
ID of the sheet being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_SEND_REPORT_BY_EMAILSend a report attachment by email. This has an irreversible external effect.

Input Parameters

object
Email and attachment settings.
string
required
ID of the report to send.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_SEND_ROWS_BY_EMAILSend selected Smartsheet rows by email. This operation has an irreversible external effect.

Input Parameters

object
Rows, columns, recipients, and email presentation options.
string
required
ID of the sheet containing the rows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_SEND_SHEET_BY_EMAILSends the sheet as an Excel, PDF, or PDF Gantt attachment via email to designated recipients. This operation has an irreversible external effect.

Input Parameters

object
SheetEmail object
string
required
ID of the sheet being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_SET_DASHBOARD_PUBLISH_STATUSPublishes or unpublishes a Smartsheet dashboard.

Input Parameters

object
Desired dashboard publish settings.
string
required
ID of the dashboard to publish or unpublish.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_SET_REPORT_PUBLISH_STATUSSet report publishing status and return the resulting public URL when enabled.

Input Parameters

object
New report publishing settings.
string
required
ID of the report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_SET_SHEET_PUBLISH_STATUSSets the publish status of the sheet and returns the new status, including the URLs of any enabled publishings.

Input Parameters

object
required
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).
string
required
ID of the sheet being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_SHARE_ASSETShares a Smartsheet asset with specified users or groups.

Input Parameters

array
Recipients and access levels to add.
string
required
Numeric or string ID of the asset to share.
string ("sheet" | "report" | "sight" | "workspace" | "collection" | "file")
required
Type of asset to share.
boolean
Notify recipients by email; at most 1000 emails are sent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_SORT_ROWS_IN_SHEETSort all rows in a Smartsheet sheet by one or more prioritized column criteria.

Input Parameters

object
Columns and directions used to sort the sheet rows.
string
required
ID of the sheet whose rows to sort.
string
Relevant Get Sheet include or exclude query options accepted by this operation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_UPDATE_ASSET_SHAREUpdates the access level of a share for a Smartsheet asset.

Input Parameters

object
New access level for the share.
string
required
Numeric or string ID of the asset.
string
required
Unique ID of the share.
string ("sheet" | "report" | "sight" | "workspace" | "collection" | "file")
required
Type of asset containing the share.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_UPDATE_AUTOMATION_RULEUpdates an existing automation rule.

Input Parameters

object
Automation rule fields to update.
string
required
ID of the sheet being accessed.
string
required
ID of the automation rule being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_UPDATE_COLUMNUpdates, moves, or renames a sheet column.

Input Parameters

object
Column fields to update.
string
required
ID of the sheet being accessed.
string
required
ID of the sheet column being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_UPDATE_DASHBOARDRenames a specified Smartsheet dashboard.

Input Parameters

object
Dashboard fields to update.
string
required
ID of the dashboard to rename.
boolean
Use Unix epoch milliseconds for date-time values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_UPDATE_FOLDERUpdates a Smartsheet folder.

Input Parameters

object
Folder fields to update.
string
required
ID of the folder to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_UPDATE_GROUPUpdates a group. Requires group administrator or system administrator access.

Input Parameters

object
Group fields to update.
string
required
ID of the group to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_UPDATE_PROOF_STATUSSets a proof as complete or incomplete.

Input Parameters

object
Proof completion status update.
string
required
ID of the original proof.
string
required
ID of the sheet being accessed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_UPDATE_REPORT_COLUMNUpdate a report column’s title, position, visibility, or width.

Input Parameters

object
Report column fields to update.
string
required
ID of the report.
string
required
Virtual ID of the report column.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_UPDATE_REPORT_DEFINITIONCreate or entirely replace a report definition.

Input Parameters

object
Complete replacement report definition.
string
required
ID of the report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_UPDATE_ROWSUpdate one row or a batch of up to 500 rows, including cells and location operations such as moving, indenting, or outdenting.

Input Parameters

string
required
One row update or an array of up to 500 row updates.
string
required
ID of the sheet containing the rows.
boolean
Clear existing formatting from updated rows and cells.
string
Access API level; use 1 to permit COMMENTER semantics.
boolean
Allow values outside column validation limits.
boolean
Allow valid rows to succeed when others fail.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_UPDATE_SHEETUpdates a sheet’s name, project settings, or the connected user’s sheet settings.

Input Parameters

object
Sheet object limited to the following attributes: * name (optional). * projectSettings (optional): ProjectSettings object, containing at least one of the projectSettings attributes, for updating this sheet’s project settings and dependencies. * userSettings (optional): SheetUserSettings object 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.
string
required
ID of the sheet being accessed.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_UPDATE_SUMMARY_FIELDSUpdates summary fields on a sheet.

Input Parameters

array
required
Summary fields to update.
string
required
ID of the sheet being accessed.
boolean
Rename duplicate field titles to make them unique.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_UPDATE_UPDATE_REQUESTChanges an update request that still has a future scheduled delivery.

Input Parameters

object
required
Update request attributes to change.
string
required
ID of the sheet being accessed.
string
required
ID of the update request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_UPDATE_USERUpdate user attributes; when a body is supplied, omitted admin and licensed sheet creator settings are sent as false. Requires System Admin permission; modifying a user-model organization member also requires membership in that organization.

Input Parameters

object
User attributes to update.
integer
required
ID of the user to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_UPDATE_USER_PROFILE_IMAGEUpload 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

object
GIF, JPG, or PNG file for binary or multipart upload.
integer
required
ID of the user whose profile image to update.
object
URL attachment request used only with application/json mode.
string ("application/octet-stream" | "multipart/form-data" | "application/json")
required
Request media type. Supply only the inputs required by the selected mode.
object
Non-file multipart fields used only with multipart/form-data mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_UPDATE_WEBHOOKUpdates a webhook owned by the connected API-token user. Requires a personal API access token because OAuth administration is app-wide.

Input Parameters

object
Mutable webhook fields to update.
string
required
ID of the webhook to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_UPDATE_WORKSPACEUpdates the name of a Smartsheet workspace.

Input Parameters

object
Workspace fields to update.
string
required
ID of the workspace to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SMARTSHEET_UPGRADE_USERIrreversibly upgrade a user’s seat in a specified plan. GUEST is valid only for external users. Requires System Admin permission.

Input Parameters

object
Seat type upgrade request; defaults to MEMBER when supplied without seatType.
integer
required
Plan ID in which to upgrade the user’s seat.
integer
required
ID of the user to upgrade.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not