Skip to main content

Smartsheet Component

Interact with the Smartsheet API

Component key: smartsheet

Description#

Smartsheet is a software as a service offering for collaboration and work management, developed and marketed by Smartsheet Inc. This component allows you to manage and interact with a Smartsheet sheets.

This component wraps the most popular endpoints listed in the Smartsheet API docs. If you need access to an endpoint that is not covered by an action in this component, you can use the Raw Request action to issue a GET, POST, PUT or DELETE against any Smartsheet API endpoint.

A note on webhooks#

We encourage you to create/configure webhooks in a flow that is triggered at Instance Deploy using the Create Webhook action. That action can be configured to create a webhook for a given sheet, and can reference the trigger's payload to fetch sibling flows' webhook URLs.

To remove webhooks, leverage the built-in Delete Instance Webhooks action to delete all webhooks in Smartsheet that point to a flow of the current instance.

Smartsheet Connections#

Smartsheet API Key#

API keys can be used for development purposes, though you should use an OAuth 2.0 connection for production integrations. Information about getting started and creating API keys with Smartsheet can be found on their developer documentation site.

InputDefaultNotes
Input
API Key
string
/ Required
Default
Notes
Provide a string value for the API Key.
Input
Base URL
string
/ Required
Default
https://api.smartsheet.com/2.0/
Notes
Most applications use Smartsheet commercial, but you can choose to use a government endpoint if your customers are government entities.

OAuth 2.0#

InputDefaultNotesExample
Input
Authorization URL
string
/ Required
Default
https://app.smartsheet.com/b/authorize
Notes
Authorization URL
Example
 
Input
Base URL
string
/ Required
Default
https://api.smartsheet.com/2.0/
Notes
Most applications use Smartsheet commercial, but you can choose to use a government endpoint if your customers are government entities.
Example
 
Input
App client id
string
/ Required
Default
Notes
This is generated when you create an app within Smartsheet's 'Developer Tools'
Example
abcdefghijklmnop123
Input
App secret
string
/ Required
Default
Notes
This is generated when you create an app within Smartsheet's 'Developer Tools'
Example
abcdefghijklmnop123
Input
Scopes
string
/ Required
Default
ADMIN_SHEETS ADMIN_SIGHTS ADMIN_USERS ADMIN_WEBHOOKS ADMIN_WORKSPACES CREATE_SHEETS CREATE_SIGHTS DELETE_SHEETS DELETE_SIGHTS READ_CONTACTS READ_EVENTS READ_SHEETS READ_SIGHTS READ_USERS SHARE_SHEETS SHARE_SIGHTS WRITE_SHEETS
Notes
A space-separated list of permissions to request. You can remove any permissions that you do not use. Descriptions of each permission is available at https://smartsheet.redoc.ly/#section/Authentication.
Example
 
Input
Token URL
string
/ Required
Default
https://api.smartsheet.com/2.0/token
Notes
Token URL
Example
 

Triggers#

Webhook#

Trigger for handling webhooks from Smartsheet | key: smartsheetWebhook

You can configure a Smartsheet webhook to send information to a Prismatic webhook URL under certain conditions (a "Column" is updated, a "Row" is deleted, etc.).

When a webhook is first configured, Smartsheet sends a confirmation request to Prismatic and is passed into the URL Verify branch beneath the trigger. All subsequent webhook requests are routed to the Event branch.

To configure a webhook, use the Create Webhook action and reference a sibling flow's webhook URL by referencing the trigger's payload.


Actions#

Add Column to Sheet#

Add column to sheet | key: columnsAddToSheet

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Description
string
Default
Notes
Column description
Input
Formula
string
Default
Notes
The formula for a column
Input
Hidden
boolean
Default
false
Notes
Indicates whether the column is hidden
Input
Position Index
string
/ Required
Default
0
Notes
Column index or position
Input
Locked
boolean
Default
false
Notes
Indicates whether the column is locked
Input
Options
string
Default
Notes
A list of options for picklists
Input
Sheet ID
string
/ Required
Default
Notes
 
Input
Title
string
/ Required
Default
Notes
Column title
Input
Type
string
/ Required
Default
Notes
 
Input
Validation
boolean
Default
false
Notes
Indicates whether validation has been enabled for the column
Input
Width
string
Default
Notes
Display width of the column in pixels

Output Example Payload#

{  "data": {    "message": "SUCCESS",    "resultCode": 0,    "result": [      {        "id": 9007194052434043,        "index": 4,        "title": "New Picklist Column 1",        "type": "PICKLIST",        "options": [          "First",          "Second",          "Third"        ],        "validation": false,        "width": 150      }    ]  }}

Add Comment#

Add a comment to a discussion | key: commentsCreate

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Discussion ID
string
/ Required
Notes
 
Input
Sheet ID
string
/ Required
Notes
 
Input
Text
string
/ Required
Notes
 

Output Example Payload#

{  "data": {    "message": "SUCCESS",    "result": {      "createdAt": "2013-02-28T22:58:30-08:00",      "createdBy": {        "email": "john.doe@smartsheet.com",        "name": "John Doe"      },      "id": 6834973207488388,      "modifiedAt": "2013-02-28T22:58:30-08:00",      "text": "This is a new comment."    },    "resultCode": 0  }}

Add/Update Row#

Add or update a row on a sheet | key: rowsAddToSheet

InputDefaultNotes
Input
Allow Partial Success
boolean
Default
false
Notes
When specified with a value of true, enables partial success for this bulk operation
Input
Column Values
string
/ Required
Key Value List
Default
Notes
A list of columns to be updated with the specified value
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Override Validation
boolean
Default
false
Notes
You may use the query string parameter **overrideValidation** with a value of **true** to allow a cell value outside of the validation limits
Input
Row Position (for new rows)
string
Default
toBottom
Notes
 
Input
Sheet ID
string
/ Required
Default
Notes
 
Input
Row ID (Optional)
string
Default
Notes
An ID of a row to update. Omit to add a new row

Output Example Payload#

{  "data": {    "message": "SUCCESS",    "resultCode": 0,    "result": [      {        "id": 3987537850460036,        "rowNumber": 1,        "expanded": true,        "createdAt": "2022-07-01T19:02:57Z",        "modifiedAt": "2022-07-01T19:02:58Z",        "cells": [          {            "columnId": 4902035581626244,            "value": false          },          {            "columnId": 2650235767940996,            "value": "New Value",            "displayValue": "New Value"          }        ]      }    ],    "version": 3  }}

Copy Rows#

Copy Rows to Another Sheet | key: copyRows

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Row Ids
string
/ Required
Value List
Notes
The IDs of the rows to move or copy from the source sheet
Example
6830028284938
Input
Source Sheet ID
string
/ Required
Notes
 
Example
 
Input
Destination Sheet ID
string
/ Required
Notes
 
Example
 

Output Example Payload#

{  "data": {    "destinationSheetId": 6166656104851332,    "rowMappings": [      {        "from": 1490138716891012,        "to": 8616643133106052      },      {        "from": 5993738344261508,        "to": 453868808497028      }    ]  }}

Copy Sheet#

Copy Sheet | key: copySheet

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Destination ID
string
Default
Notes
The ID of the destination container (when copying or moving a sheet or a folder)
Input
Destination Type
string
/ Required
Default
home
Notes
Type of the destination container
Input
New Name
string
Default
Notes
Name of the new copy
Input
Sheet ID
string
/ Required
Default
Notes
 

Output Example Payload#

{  "data": {    "message": "SUCCESS",    "resultCode": 0,    "result": {      "id": 4366633289443204,      "name": "New Sheet Name",      "accessLevel": "OWNER",      "permalink": "https://app.smartsheet.com/b/home?lx=lB0JaOh6AX1wGwqxsQIMaA"    }  }}

Create Discussion#

Create a discussion in a sheet or on a row | key: discussionsCreate

InputNotes
Input
Comment
string
/ Required
Notes
Comment
Input
Connection
connection
/ Required
Notes
 
Input
Row ID (Optional)
string
Notes
 
Input
Sheet ID
string
/ Required
Notes
 

Output Example Payload#

{  "data": {    "message": "SUCCESS",    "resultCode": 0,    "result": {      "id": 4345865909364612,      "title": "My Comment",      "comments": [        {          "id": 8565339061544836,          "text": "My Comment",          "createdBy": {            "email": "example@example.com"          },          "createdAt": "2022-06-30T22:08:09Z",          "modifiedAt": "2022-06-30T22:08:09Z"        }      ],      "commentCount": 1,      "lastCommentedAt": "2022-06-30T22:08:09Z",      "lastCommentedUser": {        "email": "example@example.com"      },      "createdBy": {        "email": "example@example.com"      }    },    "version": 24  }}

Create Folder#

Create Folder | key: createFolder

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Folder ID
string
Notes
Enter the ID of a folder to create a subfolder in, or omit this value to create a top-level home folder.
Example
 
Input
Folder Name
string
/ Required
Notes
 
Example
My Folder
Input
Workspace ID (Optional)
string
Notes
Create in this workspace. Optional.
Example
 

Output Example Payload#

{  "data": {    "message": "SUCCESS",    "resultCode": 0,    "result": {      "id": 3989276003198852,      "name": "My New Folder",      "permalink": "https://app.smartsheet.com/folders/jrWJMrFqfFf82WjGfX4rHW755FCrWfvJ4Mc3G5f1"    }  }}

Create Sheet#

Create a new sheet | key: createSheet

InputDefaultNotes
Input
Columns
code
/ Required
Default
[  {    "title": "Favorite",    "type": "CHECKBOX",    "symbol": "STAR"  },  {    "title": "Primary Column",    "primary": true,    "type": "TEXT_NUMBER"  }]
Notes
See https://smartsheet-platform.github.io/api-docs/?shell#column-types for additional information about column types.
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Folder ID
string
Default
Notes
Create sheet in this folder. Omit to create a top-level sheet.
Input
Sheet Name
string
/ Required
Default
Notes
 
Input
Workspace ID (Optional)
string
Default
Notes
 

Output Example Payload#

{  "data": {    "message": "SUCCESS",    "resultCode": 0,    "result": {      "id": 4153158256617348,      "name": "My Sheet",      "accessLevel": "OWNER",      "permalink": "https://app.smartsheet.com/sheets/wC88GhRM32m4jwvjcgvGrW82Qcm4Q7Rpp3XQQGc1",      "columns": [        {          "id": 7935520919578500,          "version": 0,          "index": 0,          "title": "Favorite",          "type": "CHECKBOX",          "symbol": "STAR",          "validation": false,          "width": 150        },        {          "id": 617171525101444,          "version": 0,          "index": 1,          "title": "Primary Column",          "type": "TEXT_NUMBER",          "primary": true,          "validation": false,          "width": 150        }      ]    }  }}

Create Webhook#

Create and enable a webhook | key: createWebhook

InputDefaultNotes
Input
Allow Duplicates?
boolean
Default
false
Notes
By default this action checks if a webhook with this callback and sheet ID already exists. If it does, this action does not configure a new webhook. Toggle this to true to allow the creation of duplicate webhooks.
Input
Callback URL
string
/ Required
Default
Notes
This is usually a reference to another flow's webhook URL
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Webhook Name
string
/ Required
Default
Notes
 
Input
Sheet ID
string
/ Required
Default
Notes
 

By default this action checks if a webhook is already configured for the given sheet and callback URL, and does not create duplicate webhooks if one already exists. That behavior can be overridden through the Allow Duplicates? input.

Output Example Payload#

{  "data": {    "message": "UNCHANGED",    "resultCode": 0,    "result": {      "id": 8951687911106436,      "name": "Example Webhook",      "apiClientId": "ixubfhznhzs4qmmurvm",      "apiClientName": "Taylor Test App",      "scope": "sheet",      "scopeObjectId": 285065612683140,      "subscope": {        "columnIds": []      },      "events": [        "*.*"      ],      "callbackUrl": "https://hooks.prismatic.io/trigger/EXAMPLE",      "sharedSecret": "289c4s9hnfp4b368x4p4wu9gea",      "enabled": true,      "status": "ENABLED",      "version": 1,      "createdAt": "2022-06-27T21:34:21Z",      "modifiedAt": "2022-06-27T21:34:24Z"    }  }}

Create Workspace#

Create Workspace | key: createWorkspace

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Workspace Name
string
/ Required
Notes
 
Example
New Workspace

Output Example Payload#

{  "data": {    "message": "SUCCESS",    "resultCode": 0,    "result": {      "accessLevel": "OWNER",      "id": 7960873114331012,      "name": "New workspace",      "permalink": "https://app.smartsheet.com/b/home?lx=rBU8QqUVPCJ3geRgl7L8yQ"    }  }}

Delete Column#

Delete column from a sheet | key: columnDelete

InputNotes
Input
Column ID
string
/ Required
Notes
 
Input
Connection
connection
/ Required
Notes
 
Input
Sheet ID
string
/ Required
Notes
 

Output Example Payload#

{  "data": {    "message": "SUCCESS",    "resultCode": 0  }}

Delete Comment#

Delete a comment by ID | key: commentDelete

InputNotes
Input
Comment ID
string
/ Required
Notes
 
Input
Connection
connection
/ Required
Notes
 
Input
Sheet ID
string
/ Required
Notes
 

Output Example Payload#

{  "data": {    "message": "SUCCESS",    "resultCode": 0,    "version": 12  }}

Delete Discussion#

Delete a discussion from a sheet or row | key: discussionDelete

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Discussion ID
string
/ Required
Notes
 
Input
Sheet ID
string
/ Required
Notes
 

Output Example Payload#

{  "data": {    "message": "SUCCESS",    "resultCode": 0  }}

Delete Folder#

Delete Folder | key: deleteFolder

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Folder ID
string
/ Required
Notes
Folder ID where you can create sheets, sights, reports, templates, and other folders

Output Example Payload#

{  "data": {    "message": "SUCCESS",    "resultCode": 0  }}

Delete Instance Webhooks#

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

InputNotes
Input
Connection
connection
/ Required
Notes
 

Output Example Payload#

{  "data": null}

Delete Row#

Delete Row | key: deleteRow

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Row ID
string
/ Required
Notes
 
Input
Sheet ID
string
/ Required
Notes
 

Output Example Payload#

{  "data": {    "message": "SUCCESS",    "resultCode": 0,    "result": [      207098194749316    ]  }}

Delete Sheet#

Delete Sheet | key: deleteSheet

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Sheet ID
string
/ Required
Notes
 

Output Example Payload#

{  "data": {    "message": "SUCCESS",    "resultCode": 0  }}

Delete Webhook#

Delete webhook | key: deleteWebhook

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Webhook ID
string
/ Required
Notes
 

Output Example Payload#

{  "data": {    "message": "SUCCESS",    "resultCode": 0  }}

Delete Workspace#

Delete Workspace | key: deleteWorkspace

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Workspace ID
string
/ Required
Notes
 

Output Example Payload#

{  "data": {    "message": "SUCCESS",    "resultCode": 0  }}

Edit Comment#

Edit a comment by ID | key: commentEdit

InputNotes
Input
Comment ID
string
/ Required
Notes
 
Input
Connection
connection
/ Required
Notes
 
Input
Sheet ID
string
/ Required
Notes
 
Input
Text
string
/ Required
Notes
 

Output Example Payload#

{  "data": {    "message": "SUCCESS",    "resultCode": 0,    "result": {      "id": 7144101943502724,      "discussionId": 4503677744506756,      "text": "This is the updated comment text.",      "createdBy": {        "name": "John Doe",        "email": "john.doe@smartsheet.com"      },      "createdAt": "2013-01-10T13:43:26Z",      "modifiedAt": "2013-01-12T19:00:26Z"    },    "version": 18  }}

Get column#

Get Column by ID | key: columnGet

InputNotes
Input
Column ID
string
/ Required
Notes
 
Input
Connection
connection
/ Required
Notes
 
Input
Sheet ID
string
/ Required
Notes
 

Output Example Payload#

{  "data": {    "id": 7960873114331012,    "index": 2,    "symbol": "STAR",    "title": "Favorite",    "type": "CHECKBOX",    "validation": false  }}

Get Comment#

Get a comment by ID | key: commentGet

InputNotes
Input
Comment ID
string
/ Required
Notes
 
Input
Connection
connection
/ Required
Notes
 
Input
Sheet ID
string
/ Required
Notes
 

Output Example Payload#

{  "data": {    "text": "This is a comment",    "createdBy": {      "name": "John Doe",      "email": "john.doe@smartsheet.com"    },    "createdAt": "2013-06-24T21:07:45Z",    "modifiedAt": "2013-06-24T21:07:45Z",    "discussionId": 4503677744506756,    "id": 48569348493401200  }}

Get Contact#

Get Contact | key: getContact

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Contact ID
string
/ Required
Notes
contactId of the contact being accessed

Output Example Payload#

{  "data": {    "id": "AAeDyHYU54QAB4PIdhTnhA",    "name": "John Doe",    "email": "john.doe@example.com"  }}

Get Discussion#

Get discussion by ID | key: discussionGet

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Discussion ID
string
/ Required
Notes
 
Input
Sheet ID
string
/ Required
Notes
 

Output Example Payload#

{  "data": {    "id": 1587586573592452,    "title": "My Comment",    "comments": [      {        "id": 4718943518648196,        "text": "My Comment",        "createdBy": {          "email": "example@example.com"        },        "createdAt": "2022-06-30T22:06:15Z",        "modifiedAt": "2022-06-30T22:06:15Z"      }    ],    "commentCount": 1,    "accessLevel": "OWNER",    "parentType": "ROW",    "parentId": 7119638251104132,    "lastCommentedAt": "2022-06-30T22:06:15Z",    "lastCommentedUser": {      "email": "example@example.com"    },    "createdBy": {      "email": "example@example.com"    }  }}

Get Folder#

Get Folder | key: getFolder

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Folder ID
string
/ Required
Notes
Folder ID where you can create sheets, sights, reports, templates, and other folders

Output Example Payload#

{  "data": {    "id": 4739830128109444,    "name": "My Folder",    "permalink": "https://app.smartsheet.com/folders/V9rx6x5JXXxR28GHfw9vCW8RcWR44HHJrjWPfHr1",    "sheets": [      {        "id": 5577163253540740,        "name": "My Test Sheet",        "accessLevel": "OWNER",        "permalink": "https://app.smartsheet.com/sheets/ppG8788PjXmQFh4PjpvfMrRfQFvjC3cG6fM4G231",        "source": {          "id": 4503604829677444,          "type": "sheet"        },        "createdAt": "2022-06-27T15:03:02Z",        "modifiedAt": "2022-06-27T15:03:02Z",        "owner": "example@example.com",        "ownerId": 789168465962884,        "version": 0      },      {        "id": 6913677619160964,        "name": "My Task List",        "accessLevel": "OWNER",        "permalink": "https://app.smartsheet.com/sheets/P88MWxqggQxpCH3cJq3PfwXj98Wcg2pxGfcPMH51",        "source": {          "id": 2251805015992196,          "type": "sheet"        },        "createdAt": "2022-06-27T15:03:07Z",        "modifiedAt": "2022-06-27T15:03:07Z",        "owner": "example@example.com",        "ownerId": 789168465962884,        "version": 0      }    ]  }}

Get Group#

Get Group | key: getGroup

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Group ID
string
/ Required
Notes
 

Output Example Payload#

{  "data": {    "id": 2295323772118916,    "name": "Example Group",    "owner": "example@example.com",    "ownerId": 789168465962884,    "members": [      {        "id": 789168465962884,        "email": "example@example.com"      }    ],    "createdAt": "2022-06-27T18:31:44Z",    "modifiedAt": "2022-06-27T18:31:44Z"  }}

Get Report#

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

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Pagination Page
string
Default
1
Notes
Which page to return
Input
Pagination Page Size
string
Default
100
Notes
The maximum number of items to return per page
Input
Report ID
string
/ Required
Default
Notes
 

Get Reports#

Get Reports | key: getReports

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Modified Since
string
Notes
When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified

Output Example Payload#

{  "data": {    "pageNumber": 1,    "pageSize": 100,    "totalPages": 1,    "totalCount": 3,    "data": [      {        "id": 2536865426368388,        "name": "2. Task Summary Report",        "accessLevel": "OWNER",        "permalink": "https://app.smartsheet.com/reports/3qmCpFWQ3MVqwF5hCHmxjVrPw8cW9CQR8H2pcVr1",        "isSummaryReport": false      }    ]  }}

Get Row#

Get the contents of a row by ID | key: rowGet

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Row ID
string
/ Required
Notes
 
Input
Sheet ID
string
/ Required
Notes
 

Output Example Payload#

{  "data": {    "id": 1490138716891012,    "sheetId": 285065612683140,    "rowNumber": 2,    "parentId": 7119638251104132,    "version": 49,    "permalink": "https://app.smartsheet.com/sheets/jVm6gg56FHw65FFPGfQrHjhMCJ9R42jqMxMvHvP1?rowId=1490138716891012",    "filteredOut": false,    "expanded": true,    "accessLevel": "OWNER",    "createdAt": "2022-06-23T20:05:05Z",    "createdBy": {      "email": "dev@prismatic.io"    },    "modifiedAt": "2022-06-23T20:05:07Z",    "modifiedBy": {      "email": "dev@prismatic.io"    },    "cells": [      {        "columnId": 4275832638203780,        "columnType": "TEXT_NUMBER",        "value": "My Subtask 1",        "objectValue": "My Subtask 1",        "displayValue": "My Subtask 1",        "format": ",,,,,,,,,,,,,,,1,"      },      {        "columnId": 8779432265574276,        "columnType": "CONTACT_LIST",        "value": "dev@prismatic.io",        "objectValue": {          "objectType": "CONTACT",          "email": "dev@prismatic.io",          "name": "dev@prismatic.io"        },        "displayValue": "dev@prismatic.io"      },      {        "columnId": 194445475899268,        "columnType": "DATE",        "value": "2022-06-23",        "objectValue": {          "objectType": "DATE",          "value": "2022-06-23"        }      }    ]  }}

Get Sheet#

Get sheet by sheet ID | key: getSheet

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Pagination Page
string
Default
1
Notes
Which page to return
Input
Pagination Page Size
string
Default
100
Notes
The maximum number of items to return per page
Input
Sheet ID
string
/ Required
Default
Notes
 

Output Example Payload#

{  "data": {    "id": 4583173393803140,    "name": "sheet 1",    "version": 6,    "totalRowCount": 240,    "accessLevel": "OWNER",    "effectiveAttachmentOptions": [      "EVERNOTE",      "GOOGLE_DRIVE",      "EGNYTE",      "FILE",      "ONEDRIVE",      "DROPBOX",      "BOX_COM"    ],    "readOnly": true,    "ganttEnabled": true,    "dependenciesEnabled": true,    "resourceManagementEnabled": true,    "cellImageUploadEnabled": true,    "userSettings": {      "criticalPathEnabled": false,      "displaySummaryTasks": true    },    "userPermissions": {      "summaryPermissions": "ADMIN"    },    "workspace": {      "id": 825898975642500,      "name": "New Workspace"    },    "projectSettings": {      "workingDays": [        "MONDAY",        "TUESDAY",        "WEDNESDAY"      ],      "nonWorkingDays": [],      "lengthOfDay": 8    },    "hasSummaryFields": false,    "permalink": "https://app.smartsheet.com/b/home?lx=pWNSDH9itjBXxBzFmyf-5w",    "createdAt": "2018-09-24T20:27:57Z",    "modifiedAt": "2018-09-26T20:45:08Z",    "columns": [      {        "id": 4583173393803140,        "version": 1,        "index": 0,        "primary": true,        "title": "Primary Column",        "type": "TEXT_NUMBER",        "validation": false      },      {        "id": 603843458295684,        "version": 2,        "index": 5,        "title": "New Dropdown Multi Select",        "type": "MULTI_PICKLIST",        "options": [          "Template",          "Blog",          "Newsletter",          "Email",          "Press Release",          "Advertisement"        ],        "validation": false,        "width": 150      }    ],    "rows": []  }}

Get Sheet Attachment#

Get metadata about an attachment on a sheet | key: attachmentsGet

InputNotes
Input
Attachment ID
string
/ Required
Notes
 
Input
Connection
connection
/ Required
Notes
 
Input
Sheet ID
string
/ Required
Notes
 

Output Example Payload#

{  "data": {    "name": "expense_report_sample.png",    "url": "https://api.smartsheet.com/download/aa402974cdb74cb58d9",    "attachmentType": "FILE",    "mimeType": "image/png",    "id": 4583173393803140,    "urlExpiresInMillis": 120000  }}

Get Sheet Publish Status#

Get Sheet Publish Status | key: getSheetPublish

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Sheet ID
string
/ Required
Notes
 

Output Example Payload#

{  "data": {    "readOnlyLiteEnabled": false,    "readOnlyFullEnabled": true,    "readWriteEnabled": false,    "icalEnabled": false,    "readOnlyFullAccessibleBy": "ALL",    "readOnlyFullUrl": "https://publish.smartsheet.com/6d35fa6c99334d4892f9591cf6065"  }}

Get Sheet Version#

Get Sheet Version | key: getSheetVersion

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Sheet ID
string
/ Required
Notes
 

Output Example Payload#

{  "data": {    "version": 4  }}

Get User#

Get User | key: getUser

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
User ID
string
/ Required
Notes
The ID of a user to fetch. Enter 'me' to get currently logged in user

Output Example Payload#

{  "data": {    "id": 48569348493401200,    "email": "john.doe@smartsheet.com",    "firstName": "John",    "lastName": "Doe",    "locale": "en_US",    "timeZone": "US/Pacific",    "account": {      "name": "Team Smartsheet",      "id": 942513719853956    },    "admin": true,    "licensedSheetCreator": true,    "groupAdmin": true,    "resourceViewer": true,    "jiraAdmin": false,    "salesforceAdmin": false,    "salesforceUser": false,    "alternateEmails": [      {        "id": 12345,        "email": "altEmail1@smartsheet.com",        "confirmed": true      }    ],    "title": "Senior Sales Representative",    "department": "Marketing",    "company": "Smartsheet",    "workPhone": "",    "mobilePhone": "206 123-4567",    "role": "Sales",    "profileImage": {      "imageId": "u!1!8ljad7w9-aY!AsDeH0wWv1Y!y9VvAgUOFdg",      "height": 1050,      "width": 1050    },    "sheetCount": 3,    "lastLogin": "2016-08-15T18:32:47Z",    "customWelcomeScreenViewed": "2016-08-12T12:15:47Z",    "groups": {      "id": 12345,      "name": "Team dev"    }  }}

Get Webhook#

Get webhook by ID | key: getWebhook

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Webhook ID
string
/ Required
Notes
 

Output Example Payload#

{  "data": {    "id": 8951687911106436,    "name": "Example Webhook",    "apiClientId": "ixubfhznhzs4qmmurvm",    "apiClientName": "Taylor Test App",    "scope": "sheet",    "scopeObjectId": 285065612683140,    "subscope": {      "columnIds": []    },    "events": [      "*.*"    ],    "callbackUrl": "https://hooks.prismatic.io/trigger/EXAMPLE",    "sharedSecret": "289c4s9hnfp4b368x4p4wu9gea",    "enabled": true,    "status": "ENABLED",    "version": 1,    "createdAt": "2022-06-27T21:34:21Z",    "modifiedAt": "2022-06-27T21:34:24Z"  }}

Get Workspace#

Get Workspace | key: getWorkspace

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Load All
boolean
Default
false
Notes
Set to true to see nested folders
Input
Workspace ID
string
/ Required
Default
Notes
 

Output Example Payload#

{  "data": {    "sheets": [      {        "id": 4583173393803140,        "name": "sheet 1",        "accessLevel": "OWNER",        "permalink": "https://app.smartsheet.com/b/home?lx=8Z0XuFUEAkxmHCSsMw4Zg1",        "createdAt": "2015-06-05T20:05:29Z",        "modifiedAt": "2015-06-05T20:05:43Z"      }    ],    "accessLevel": "OWNER",    "id": 7116448184199044,    "name": "New workspace",    "permalink": "https://app.smartsheet.com/b/home?lx=8Z0XuFUEAkxmHCSsMw4Zgg"  }}

List Attachments on Row#

List attachments on a row of a sheet | key: attachmentsListOnRow

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Include All
boolean
Default
true
Notes
If true, include all results. Do not paginate.
Input
Pagination Page
string
Default
1
Notes
Which page to return
Input
Pagination Page Size
string
Default
100
Notes
The maximum number of items to return per page
Input
Row ID
string
/ Required
Default
Notes
 
Input
Sheet ID
string
/ Required
Default
Notes
 

Output Example Payload#

{  "data": {    "pageNumber": 1,    "pageSize": 100,    "totalPages": 1,    "totalCount": 2,    "data": [      {        "name": "att3.png",        "attachmentType": "FILE",        "mimeType": "image/png",        "id": 4583173393803140,        "parentType": "ROW",        "parentId": 341847495283      },      {        "name": "att4.png",        "attachmentType": "FILE",        "mimeType": "image/png",        "id": 7993173393803140,        "parentType": "COMMENT",        "parentId": 684956754834557      }    ]  }}

List Attachments on Sheet#

List attachments on a sheet | key: attachmentsListOnSheet

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Include All
boolean
Default
true
Notes
If true, include all results. Do not paginate.
Input
Pagination Page
string
Default
1
Notes
Which page to return
Input
Pagination Page Size
string
Default
100
Notes
The maximum number of items to return per page
Input
Sheet ID
string
/ Required
Default
Notes
 

Output Example Payload#

{  "data": {    "pageNumber": 1,    "pageSize": 100,    "totalPages": 1,    "totalCount": 2,    "data": [      {        "name": "att3.png",        "attachmentType": "FILE",        "mimeType": "image/png",        "id": 4583173393803140,        "parentType": "SHEET",        "parentId": 341847495283      },      {        "name": "att4.png",        "attachmentType": "FILE",        "mimeType": "image/png",        "id": 7993173393803140,        "parentType": "ROW",        "parentId": 684956754834557      }    ]  }}

List Columns#

List the columns of a sheet | key: columnsListOnSheet

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Include All
boolean
Default
true
Notes
If true, include all results. Do not paginate.
Input
Pagination Page
string
Default
1
Notes
Which page to return
Input
Pagination Page Size
string
Default
100
Notes
The maximum number of items to return per page
Input
Sheet ID
string
/ Required
Default
Notes
 

Output Example Payload#

{  "data": {    "pageNumber": 1,    "pageSize": 100,    "totalPages": 1,    "totalCount": 3,    "data": [      {        "id": 7960873114331012,        "index": 0,        "symbol": "STAR",        "title": "Favorite",        "type": "CHECKBOX",        "validation": false      },      {        "id": 642523719853956,        "index": 1,        "primary": true,        "title": "Primary Column",        "type": "TEXT_NUMBER",        "validation": false      },      {        "id": 5146123347224452,        "index": 2,        "title": "Status",        "type": "PICKLIST",        "validation": false      }    ]  }}

List Contacts#

List Contacts | key: listContacts

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Include All
boolean
Default
true
Notes
If true, include all results. Do not paginate.
Input
Pagination Page
string
Default
1
Notes
Which page to return
Input
Pagination Page Size
string
Default
100
Notes
The maximum number of items to return per page

Output Example Payload#

{  "data": {    "pageNumber": 1,    "totalPages": 1,    "totalCount": 1,    "data": [      {        "id": "AAeDyHYU54QAB4PIdhTnhA",        "name": "John Doe",        "email": "john.doe@example.com"      }    ]  }}

List Discussion Attachments#

List Discussion Attachments | key: discussionListAttachments

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Discussion ID
string
/ Required
Default
Notes
 
Input
Include All
boolean
Default
true
Notes
If true, include all results. Do not paginate.
Input
Pagination Page
string
Default
1
Notes
Which page to return
Input
Pagination Page Size
string
Default
100
Notes
The maximum number of items to return per page
Input
Sheet ID
string
/ Required
Default
Notes
 

Output Example Payload#

{  "data": {    "pageNumber": 1,    "pageSize": 100,    "totalPages": 1,    "totalCount": 2,    "data": [      {        "name": "att3.png",        "attachmentType": "FILE",        "mimeType": "image/png",        "id": 4583173393803140,        "parentType": "COMMENT",        "parentId": 341847495283      },      {        "name": "att4.png",        "attachmentType": "FILE",        "mimeType": "image/png",        "id": 7993173393803140,        "parentType": "COMMENT",        "parentId": 684956754834557      }    ]  }}

List Discussions#

List discussions on a sheet or row | key: discussionsList

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Include All
boolean
Default
true
Notes
If true, include all results. Do not paginate.
Input
Pagination Page
string
Default
1
Notes
Which page to return
Input
Pagination Page Size
string
Default
100
Notes
The maximum number of items to return per page
Input
Row ID (Optional)
string
Default
Notes
 
Input
Sheet ID
string
/ Required
Default
Notes
 

Output Example Payload#

{  "data": {    "pageNumber": 1,    "pageSize": 100,    "totalPages": 1,    "totalCount": 1,    "data": [      {        "id": 3138415114905476,        "title": "Lincoln",        "comments": [          {            "id": 7320407591151492,            "text": "16th President",            "createdBy": {              "name": "Test User",              "email": "tester@smartsheet.com"            },            "createdAt": "2015-01-12T18:23:02-08:00",            "modifiedAt": "2015-01-12T18:23:02-08:00"          }        ],        "commentCount": 1,        "accessLevel": "OWNER",        "parentType": "ROW",        "parentId": 4508369022150532,        "lastCommentedUser": {          "name": "Test User",          "email": "tester@smartsheet.com"        },        "createdBy": {          "name": "Test User",          "email": "tester@smartsheet.com"        },        "readOnly": false,        "lastCommentedAt": "2015-01-12T18:23:02-08:00"      }    ]  }}

List Events#

Gets events that are occurring in your Smartsheet organization account | key: listEvents

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Max Count
string
Default
1000
Notes
Maximum number of events to return as response to this call
Example
 
Input
Since
string
Default
2010-01-01T00:00:00Z
Notes
Starting time for events to return
Example
 
Input
Stream Position
string
Default
Notes
Indicates next set of events to return
Example
XyzAb1234cdefghijklmnofpq

Output Example Payload#

{  "data": {    "nextStreamPosition": "XyzAb1234cdefghijklmnofpq",    "moreAvailable": "false",    "data": [      {        "eventId": "4b12345abc444def333g149he2b15b3j",        "objectType": "SHEET",        "action": "LOAD",        "objectId": "345678901234",        "eventTimestamp": "2019-04-29T08:28:33Z",        "userId": "123457654321",        "requestUserId": "133445566778",        "source": "WEB_APP",        "additionalDetails": {}      }    ]  }}

List Favorites#

List Favorites | key: getFavorites

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Include All
boolean
Default
true
Notes
If true, include all results. Do not paginate.
Input
Pagination Page
string
Default
1
Notes
Which page to return
Input
Pagination Page Size
string
Default
100
Notes
The maximum number of items to return per page

Output Example Payload#

{  "data": {    "pageNumber": 1,    "pageSize": 100,    "totalPages": 1,    "totalCount": 2,    "data": [      {        "type": "sheet",        "objectId": 5897312590423940      },      {        "type": "folder",        "objectId": 1493728255862660      }    ]  }}

List Folders#

List folders, subfolders or workspace folders | key: listFolders

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Folder ID
string
Default
Notes
Enter the ID of a folder to list subfolders, or omit this value to list top-level home folders.
Input
Include All
boolean
Default
true
Notes
If true, include all results. Do not paginate.
Input
Pagination Page
string
Default
1
Notes
Which page to return
Input
Pagination Page Size
string
Default
100
Notes
The maximum number of items to return per page
Input
Workspace ID (Optional)
string
Default
Notes
Create in this workspace. Optional.

Output Example Payload#

{  "data": {    "pageNumber": 1,    "totalPages": 1,    "totalCount": 3,    "data": [      {        "id": 4739830128109444,        "name": "Folder 1",        "permalink": "https://app.smartsheet.com/folders/V9rx6x5JXXxR28GHfw9vCW8RcWR44HHJrjWPfHr1"      },      {        "id": 7836054871926660,        "name": "Folder 2",        "permalink": "https://app.smartsheet.com/folders/CQmHFFGXWC67CqxjFJJQv9q4GXqpRx2m9gHg7Rx1"      }    ]  }}

List Groups#

List Org Groups | key: listGroups

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Include All
boolean
Default
true
Notes
If true, include all results. Do not paginate.
Input
Modified Since
string
Default
Notes
When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified
Input
Pagination Page
string
Default
1
Notes
Which page to return
Input
Pagination Page Size
string
Default
100
Notes
The maximum number of items to return per page

Output Example Payload#

{  "data": {    "pageNumber": 1,    "pageSize": 100,    "totalPages": 1,    "totalCount": 1,    "data": [      {        "id": 4583173393803140,        "name": "Group 1",        "description": "My group",        "owner": "john.doe@smartsheet.com",        "ownerId": 2331373580117892,        "createdAt": "2014-05-29T14:41:35-07:00",        "modifiedAt": "2014-05-29T14:41:35-07:00"      }    ]  }}

List Home Contents#

Get a nested list of all Home objects, including dashboards, folders, reports, sheets, templates, and workspaces, as shown on the "Home" tab. | key: listHomeContents

InputNotes
Input
Connection
connection
/ Required
Notes
 

Output Example Payload#

{  "data": {    "sheets": [      {        "id": 1514484968777604,        "name": "My Sheet",        "accessLevel": "OWNER",        "permalink": "https://app.smartsheet.com/sheets/28wxmmfHhc7c92JRgx8qwp3MjJ338XXgWVP5QqR1",        "createdAt": "2022-06-27T17:18:56Z",        "modifiedAt": "2022-06-27T17:18:56Z"      }    ],    "folders": [      {        "id": 1115290047145860,        "name": "My Folder",        "permalink": "https://app.smartsheet.com/folders/VRmCXx7VvJXchgPMxcR88Vq5RVH5QPW2JwVpXjF1",        "sheets": [          {            "id": 6166656104851332,            "name": "My Sheet",            "accessLevel": "OWNER",            "permalink": "https://app.smartsheet.com/sheets/pqFGc5cVvVw6hpfQ32Pw2hMFcPpVWWMhQ686QVW1",            "createdAt": "2022-06-27T17:26:20Z",            "modifiedAt": "2022-06-27T17:26:20Z"          }        ],        "folders": [          {            "id": 4739830128109444,            "name": "Subfolder 1",            "permalink": "https://app.smartsheet.com/folders/V9rx6x5JXXxR28GHfw9vCW8RcWR44HHJrjWPfHr1",            "sheets": [              {                "id": 6913677619160964,                "name": "My Task List",                "accessLevel": "OWNER",                "permalink": "https://app.smartsheet.com/sheets/P88MWxqggQxpCH3cJq3PfwXj98Wcg2pxGfcPMH51",                "createdAt": "2022-06-27T15:03:07Z",                "modifiedAt": "2022-06-27T15:03:07Z"              },              {                "id": 5577163253540740,                "name": "My Test Sheet",                "accessLevel": "OWNER",                "permalink": "https://app.smartsheet.com/sheets/ppG8788PjXmQFh4PjpvfMrRfQFvjC3cG6fM4G231",                "createdAt": "2022-06-27T15:03:02Z",                "modifiedAt": "2022-06-27T15:03:02Z"              }            ]          }        ]      }    ],    "workspaces": [      {        "id": 3776173869164420,        "name": "My Test",        "accessLevel": "OWNER",        "permalink": "https://app.smartsheet.com/workspaces/M5hwX6XMQxfvRr9xHh77XgRWGhW8VWMXrX54mhw1",        "sheets": [          {            "id": 285065612683140,            "name": "1. Task Sheet",            "accessLevel": "OWNER",            "favorite": true,            "permalink": "https://app.smartsheet.com/sheets/jVm6gg56FHw65FFPGfQrHjhMCJ9R42jqMxMvHvP1",            "createdAt": "2022-06-23T20:05:05Z",            "modifiedAt": "2022-06-24T16:55:36Z"          }        ],        "folders": [          {            "id": 5659485705398148,            "name": "Workspace Folder 1",            "permalink": "https://app.smartsheet.com/folders/5GgFJ2Rr38FjjxVP7gfR39WpC6CMPgrHM3m7rF41"          }        ],        "reports": [          {            "id": 2536865426368388,            "name": "2. Task Summary Report",            "accessLevel": "OWNER",            "permalink": "https://app.smartsheet.com/reports/3qmCpFWQ3MVqwF5hCHmxjVrPw8cW9CQR8H2pcVr1",            "createdAt": "2022-06-23T20:05:06Z",            "modifiedAt": "2022-06-23T20:05:07Z"          }        ],        "sights": [          {            "id": 2689058288756612,            "name": "4. Project Dashboard",            "accessLevel": "OWNER",            "permalink": "https://app.smartsheet.com/dashboards/jH9Q2r3P3gjPmQgX93CvvCFjHVgGq6W894Mx67W1",            "createdAt": "2022-06-23T20:05:06Z",            "modifiedAt": "2022-06-23T20:05:07Z"          }        ]      },      {        "id": 7240855267370884,        "name": "Team dev",        "accessLevel": "OWNER",        "permalink": "https://app.smartsheet.com/workspaces/69g47w4FxcFXMRfFprpwqw26qH4cvw287WW7F9R1",        "sheets": [          {            "id": 923909785708420,            "name": "Project Launch Plan",            "accessLevel": "OWNER",            "permalink": "https://app.smartsheet.com/sheets/5MXR3wMRhpmVjgPqGj2JFWfw398RhPVXfqg7Vrf1",            "createdAt": "2022-06-27T18:31:29Z",            "modifiedAt": "2022-06-27T18:31:29Z"          }        ]      }    ]  }}

List Sheets#

List Sheets | key: listSheets

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Include All
boolean
Default
true
Notes
If true, include all results. Do not paginate.
Input
Modified Since
string
Default
Notes
When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified
Input
Pagination Page
string
Default
1
Notes
Which page to return
Input
Pagination Page Size
string
Default
100
Notes
The maximum number of items to return per page

Output Example Payload#

{  "data": {    "pageNumber": 1,    "pageSize": 100,    "totalPages": 1,    "totalCount": 2,    "data": [      {        "accessLevel": "OWNER",        "id": 4583173393803140,        "name": "sheet 1",        "version": 5,        "permalink": "https://app.smartsheet.com/b/home?lx=xUefSOIYmn07iJJesvSHCQ",        "createdAt": "2015-06-05T20:05:29Z",        "modifiedAt": "2015-06-05T20:05:43Z"      },      {        "accessLevel": "OWNER",        "id": 2331373580117892,        "name": "sheet 2",        "version": 86,        "permalink": "https://app.smartsheet.com/b/home?lx=xUefSOIYmn07iJJrthEFTG",        "createdAt": "2015-06-05T20:05:29Z",        "modifiedAt": "2015-06-05T20:05:43Z"      }    ]  }}

List Users#

List Users | key: listUsers

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Email
string
Default
Notes
Find a user with this email address
Input
Include All
boolean
Default
true
Notes
If true, include all results. Do not paginate.
Input
Modified Since
string
Default
Notes
When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified
Input
Pagination Page
string
Default
1
Notes
Which page to return
Input
Pagination Page Size
string
Default
100
Notes
The maximum number of items to return per page

Output Example Payload#

{  "data": {    "pageNumber": 1,    "pageSize": 100,    "totalPages": 1,    "totalCount": 1,    "data": [      {        "id": 94094820842,        "email": "john.doe@smartsheet.com",        "name": "John Doe",        "firstName": "John",        "lastName": "Doe",        "profileImage": {          "imageId": "u!1!8ljad7w9-aY!AsDeH0wWv1Y!y9VvAgUOFdg",          "height": 1050,          "width": 1050        },        "status": "ACTIVE",        "admin": true,        "licensedSheetCreator": true,        "groupAdmin": true,        "resourceViewer": true,        "sheetCount": 3,        "lastLogin": "2016-08-15T18:32:47Z",        "customWelcomeScreenViewed": "2016-08-12T12:15:47Z"      }    ]  }}

List Webhooks#

List Webhooks | key: listWebhooks

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Show All
boolean
Default
false
Notes
By default only webhooks whose callback URLs match a flow in the current instance are shown. Toggle this to 'true' to show all webhooks (even those for other apps and instances).

Output Example Payload#

{  "data": [    {      "id": 4503604829677444,      "name": "Webhook #5",      "scope": "sheet",      "scopeObjectId": 6761855684241284,      "events": [        "*.*"      ],      "callbackUrl": "http://www.myApp.com/webhooks",      "sharedSecret": "216ejjzfoo17mq1q8xs7d4hu8b",      "enabled": true,      "status": "ENABLED",      "version": 1,      "subscope": {        "columnIds": [          7318427511613316,          7318427511613123        ]      },      "createdAt": "2020-01-03T14:52:21Z",      "modifiedAt": "2020-01-04T19:05:40Z"    }  ]}

List Workspaces#

List Workspaces | key: listWorkspaces

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Include All
boolean
Default
true
Notes
If true, include all results. Do not paginate.
Input
Pagination Page
string
Default
1
Notes
Which page to return
Input
Pagination Page Size
string
Default
100
Notes
The maximum number of items to return per page

Output Example Payload#

{  "data": {    "pageNumber": 1,    "totalPages": 1,    "totalCount": 1,    "data": [      {        "id": 3776173869164420,        "name": "My Test Workspace",        "accessLevel": "OWNER",        "permalink": "https://app.smartsheet.com/workspaces/M5hwX6XMQxfvRr9xHh77XgRWGhW8VWMXrX54mhw1"      }    ]  }}

Move Folder#

Move Folder | key: moveFolder

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Destination Folder ID
string
/ Required
Notes
Folder ID where you can create sheets, sights, reports, templates, and other folders
Input
Folder ID
string
/ Required
Notes
Folder ID where you can create sheets, sights, reports, templates, and other folders

Output Example Payload#

{  "data": {    "message": "SUCCESS",    "resultCode": 0,    "result": {      "id": 7324970943571844,      "name": "New Folder Name",      "permalink": "https://app.smartsheet.com/folders/CqwF74MP2VF73F4jV9XWHVgPvJp7jJmw9h2CrF81"    }  }}

Move Rows#

Move Rows to Another Sheet | key: moveRows

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Row IDs
string
Value List
Notes
The Ids of the rows to move or copy from the source sheet
Example
6830028284938
Input
Sheet ID
string
/ Required
Notes
 
Example
 
Input
Destination Sheet ID
string
/ Required
Notes
 
Example
 

Output Example Payload#

{  "data": {    "destinationSheetId": 2258256056870788,    "rowMappings": [      {        "from": 145417762563972,        "to": 4508365800925060      },      {        "from": 8026717110462340,        "to": 2256565987239812      }    ]  }}

Move Sheet#

Move Sheet | key: moveSheet

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Destination ID
string
Default
Notes
The ID of the destination container (when copying or moving a sheet or a folder)
Input
Destination Type
string
/ Required
Default
home
Notes
Type of the destination container
Input
Sheet ID
string
/ Required
Default
Notes
 

Output Example Payload#

{  "data": {    "message": "SUCCESS",    "resultCode": 0,    "result": {      "id": 4366633289443204,      "name": "New Sheet Name",      "accessLevel": "OWNER",      "permalink": "https://app.smartsheet.com/b/home?lx=lB0JaOh6AX1wGwqxsQIMaA"    }  }}

Raw Request#

Issue a raw HTTP request | key: rawRequest

InputDefaultNotesExample
Input
Connection
connection
/ Required
Default
 
Notes
 
Example
 
Input
Data
string
Default
Notes
The HTTP body payload to send to the URL. Must be a string or a reference to output from a previous step.
Example
{"exampleKey": "Example Data"}
Input
Debug Request
boolean
Default
false
Notes
Enabling this flag will log out the current request.
Example
 
Input
File Data
string
Key Value List
Default
Notes
File Data to be sent as a multipart form upload.
Example
[{key: "example.txt", value: "My File Contents"}]
Input
Form Data
string
Key Value List
Default
Notes
The Form Data to be sent as a multipart form upload.
Example
[{"key": "Example Key", "value": new Buffer("Hello World")}]
Input
Header
string
Key Value List
Default
Notes
A list of headers to send with the request.
Example
User-Agent: curl/7.64.1
Input
Max Retry Count
string
Default
0
Notes
The maximum number of retries to attempt.
Example
 
Input
Method
string
/ Required
Default
Notes
The HTTP method to use.
Example
 
Input
Query Parameter
string
Key Value List
Default
Notes
A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Example
 
Input
Response Type
string
/ Required
Default
json
Notes
The type of data you expect in the response. You can request json, text, or binary data.
Example
 
Input
Retry On All Errors
boolean
Default
false
Notes
If true, retries on all erroneous responses regardless of type.
Example
 
Input
Retry Delay (ms)
string
Default
0
Notes
The delay in milliseconds between retries.
Example
 
Input
Timeout
string
Default
Notes
The maximum time that a client will await a response to its request
Example
2000
Input
URL
string
/ Required
Default
Notes
This is the URL to call.
Example
/sobjects/Account
Input
Use Exponential Backoff
boolean
Default
false
Notes
Specifies whether to use a pre-defined exponential backoff strategy for retries.
Example
 

Search Sheets#

Search sheets for a particular phrase | key: searchSheet

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Text to search for
string
/ Required
Notes
Text with which to perform the search
Input
Sheet ID (Optional)
string
Notes
The ID of the sheet to search. Omit to search all sheets.

Output Example Payload#

{  "data": {    "results": [      {        "contextData": [          "Discussion 1"        ],        "objectId": 1888207043356548,        "objectType": "discussion",        "parentObjectId": 7141187195824004,        "parentObjectName": "Sheet 1",        "parentObjectType": "sheet",        "text": "discussion stuff goes here"      },      {        "contextData": [          "Row 1"        ],        "objectId": 2711817823774596,        "objectType": "row",        "parentObjectId": 2583735121012612,        "parentObjectName": "Sheet 2",        "parentObjectType": "sheet",        "text": "row stuff goes here"      }    ],    "totalCount": 2  }}

Send Sheet#

Send Sheet via Email | key: sheetSend

InputDefaultNotes
Input
CC Me
boolean
Default
false
Notes
Indicates whether to send a copy of the email to the sender
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Emails
string
Value List
Default
Notes
Send the document to these email addresses
Input
Format
string
/ Required
Default
EXCEL
Notes
 
Input
Group IDs
string
Value List
Default
Notes
Send the document to these groups by group ID
Input
Message
string
Default
Notes
The message of the email
Input
Paper Size
string
/ Required
Default
LETTER
Notes
 
Input
Sheet ID
string
/ Required
Default
Notes
 
Input
Subject
string
Default
Notes
The subject of the email

Output Example Payload#

{  "data": {    "message": "SUCCESS",    "resultCode": 0  }}

Set Sheet Publish#

Set Sheet Publish Status | key: setSheetPublish

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Ical Enabled
boolean
/ Required
Default
Notes
If true, a webcal is available for the calendar in the sheet
Input
Read Only Full Accessible By
string
/ Required
Default
ALL
Notes
Indicates who can access the 'Read-Only Full' view of the published sheet:
Input
Read Only Full Default View
string
/ Required
Default
CALENDAR
Notes
Indicates which view the user has set for a read-only, default view of the published sheet
Input
Read Only Full Enabled
boolean
Default
true
Notes
If true, a rich version of the sheet is published with the ability to download row attachments and discussions
Input
Read Only Lite Enabled
boolean
/ Required
Default
false
Notes
If true, a lightweight version of the sheet is published without row attachments and discussions
Input
Read Write Accessible By
string
/ Required
Default
ALL
Notes
Indicates who can access the 'Edit by Anyone' view of the published sheet:
Input
Read Write Default View
string
/ Required
Default
CALENDAR
Notes
Indicates which view the user has set for a read-write, default view of the published sheet
Input
Read Write Enabled
boolean
/ Required
Default
Notes
If **true**,a rich version of the sheet is published with the ability to edit cells and manage attachments and discussions
Input
Sheet ID
string
/ Required
Default
Notes
 

Output Example Payload#

{  "data": {    "message": "SUCCESS",    "resultCode": 0,    "result": {      "icalEnabled": false,      "readOnlyFullEnabled": false,      "readOnlyLiteEnabled": true,      "readOnlyLiteUrl": "http://publish.smartsheet.com/9862638d9c444014b5d7a114d436e99d",      "readWriteEnabled": false    }  }}

Templates List#

List User-Created Templates | key: templatesList

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Include All
boolean
Default
true
Notes
If true, include all results. Do not paginate.
Input
Pagination Page
string
Default
1
Notes
Which page to return
Input
Pagination Page Size
string
Default
100
Notes
The maximum number of items to return per page

Output Example Payload#

{  "data": {    "pageNumber": 1,    "pageSize": 100,    "totalPages": 1,    "totalCount": 2,    "data": [      {        "id": 3457273486960516,        "name": "template 1",        "accessLevel": "OWNER",        "description": "This is template 1"      },      {        "id": 34572734869609344,        "name": "template 2",        "accessLevel": "VIEWER",        "description": "This is template 2"      }    ]  }}

Templates List Public#

List Public Templates | key: templatesListPublic

InputDefaultNotes
Input
Connection
connection
/ Required
Default
 
Notes
 
Input
Include All
boolean
Default
true
Notes
If true, include all results. Do not paginate.
Input
Pagination Page
string
Default
1
Notes
Which page to return
Input
Pagination Page Size
string
Default
100
Notes
The maximum number of items to return per page

Output Example Payload#

{  "data": {    "pageNumber": 1,    "pageSize": 100,    "totalPages": 1,    "totalCount": 2,    "data": [      {        "id": 3457273486960516,        "name": "template 1",        "accessLevel": "OWNER",        "description": "This is template 1"      },      {        "id": 34572734869609344,        "name": "template 2",        "accessLevel": "VIEWER",        "description": "This is template 2"      }    ]  }}

Update Folder#

Update folder name | key: updateFolder

InputNotesExample
Input
Connection
connection
/ Required
Notes
 
Example
 
Input
Folder ID
string
/ Required
Notes
Folder ID where you can create sheets, sights, reports, templates, and other folders
Example
 
Input
Folder Name
string
/ Required
Notes
 
Example
My Folder

Output Example Payload#

{  "data": {    "message": "SUCCESS",    "resultCode": 0,    "result": {      "id": 5220505688008580,      "name": "New Folder Name",      "permalink": "https://app.smartsheet.com/folders/7QpC5vFJP3JXwgq7qqCgfCjP4cGmvj5GHh7G2wc1"    }  }}

Update Sheet#

Update Sheet | key: updateSheet

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
New Name
string
/ Required
Notes
 
Input
Sheet ID
string
/ Required
Notes
 

Output Example Payload#

{  "data": {    "message": "SUCCESS",    "resultCode": 0,    "result": {      "id": 7960873114331012,      "name": "New Sheet Name",      "accessLevel": "OWNER",      "userSettings": {        "criticalPathEnabled": true      },      "projectSettings": {        "workingDays": [          "MONDAY",          "TUESDAY",          "WEDNESDAY"        ],        "nonWorkingDays": [          "2018-01-01"        ],        "lengthOfDay": 6      },      "permalink": "https://app.smartsheet.com/b/home?lx=RE8LkzA48kPRWTzcgEYOga"    }  }}

Update Workspace#

Update Workspace | key: updateWorkspace

InputNotes
Input
Connection
connection
/ Required
Notes
 
Input
Name
string
/ Required
Notes
Workspace name
Input
Workspace ID
string
/ Required
Notes
 

Output Example Payload#

{  "data": {    "message": "SUCCESS",    "resultCode": 0,    "result": {      "accessLevel": "OWNER",      "id": 7960873114331012,      "name": "Updated workspace",      "permalink": "https://app.smartsheet.com/b/home?lx=rBU8QqUVPCJ3geRgl7L8yQ"    }  }}