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.

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
API Key
string
/ Required
apiKey
Provide a string value for the API Key.
Base URL
string
/ Required
baseUrl
https://api.smartsheet.com/2.0/
Most applications use Smartsheet commercial, but you can choose to use a government endpoint if your customers are government entities.

Smartsheet OAuth2​

OAuth 2.0 can be used to authenticate Smartsheet users with the click of a button. To create an OAuth 2.0 connection for Smartsheet:

  • Log in to Smartsheet, and then click the profile icon on the bottom left of the page -> Developer Tools.
  • Create a "developer profile" if you have not previously and then click Create New App.
  • Give your app a name, description, logo. You do not need to Publish App?. Under App redirect URL, enter
    https://oauth2.prismatic.io/callback
    .
  • Take note of the App client id and App secret that are generated - you'll enter those when you configure your integration.
InputDefaultNotesExample
Authorization URL
string
/ Required
authorizeUrl
https://app.smartsheet.com/b/authorize
Authorization URL
 
Base URL
string
/ Required
baseUrl
https://api.smartsheet.com/2.0/
Most applications use Smartsheet commercial, but you can choose to use a government endpoint if your customers are government entities.
 
App client id
string
/ Required
clientId
This is generated when you create an app within Smartsheet's 'Developer Tools'
abcdefghijklmnop123
App secret
password
/ Required
clientSecret
This is generated when you create an app within Smartsheet's 'Developer Tools'
abcdefghijklmnop123
Scopes
string
/ Required
scopes
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
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.
 
Token URL
string
/ Required
tokenUrl
https://api.smartsheet.com/2.0/token
Token URL
 

Triggers​

Webhook​

Receive and validate webhook requests from Smartsheet for webhooks you configure. | key: smartsheetWebhook

You can configure a Smartsheet webhook to send information to a flow's 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 webhook endpoint 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
Connection
connection
/ Required
connection
 
 
Description
string
description
Column description
Formula
string
formula
The formula for a column
Hidden
boolean
hidden
false
Indicates whether the column is hidden
Position Index
string
/ Required
index
0
Column index or position
Locked
boolean
locked
false
Indicates whether the column is locked
Options
string
options
A list of options for picklists
Sheet ID
string
/ Required
sheetId
 
Title
string
/ Required
title
Column title
Type
string
/ Required
type
 
Validation
boolean
validation
false
Indicates whether validation has been enabled for the column
Width
string
width
Display width of the column in pixels

{
  "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
Connection
connection
/ Required
connection
 
Discussion ID
string
/ Required
discussionId
 
Sheet ID
string
/ Required
sheetId
 
Text
string
/ Required
text
 

{
  "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

InputDefaultNotesExample
Allow Partial Success
boolean
allowPartialSuccess
false
When specified with a value of true, enables partial success for this bulk operation
 
Column Values
string
Key Value List
columnValues
A list of columns to be updated with the specified value
 
Connection
connection
/ Required
connection
 
 
 
Dynamic Columns Values
code
dynamicColumns
List of columns and their values
Override Validation
boolean
overrideValidation
false
You may use the query string parameter **overrideValidation** with a value of **true** to allow a cell value outside of the validation limits
 
Row Position (for new rows)
string
position
toBottom
 
 
Sheet ID
string
/ Required
sheetId
 
 
Row ID (Optional)
string
updateIdentifier
An ID of a row to update. Omit to add a new row
 

{
  "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
Connection
connection
/ Required
connection
 
 
Row Ids
string
/ Required
Value List
rowIds
The IDs of the rows to move or copy from the source sheet
6830028284938
Source Sheet ID
string
/ Required
sheetId
 
 
Destination Sheet ID
string
/ Required
toSheetId
 
 

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

Copy Sheet​

Copy Sheet | key: copySheet

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

{
  "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
Comment
string
/ Required
comment
Comment
Connection
connection
/ Required
connection
 
Row ID (Optional)
string
rowId
 
Sheet ID
string
/ Required
sheetId
 

{
  "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
Connection
connection
/ Required
connection
 
 
Folder ID
string
folderId
Enter the ID of a folder to create a subfolder in, or omit this value to create a top-level home folder.
 
Folder Name
string
/ Required
folderName
 
My Folder
Workspace ID (Optional)
string
workspaceId
Create in this workspace. Optional.
 

{
  "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
Columns
code
/ Required
columns
See https://smartsheet-platform.github.io/api-docs/?shell#column-types for additional information about column types.
Connection
connection
/ Required
connection
 
 
Folder ID
string
folderId
Create sheet in this folder. Omit to create a top-level sheet.
Sheet Name
string
/ Required
name
 
Workspace ID (Optional)
string
workspaceId
 

{
  "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
Allow Duplicates?
boolean
allowDuplicates
false
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.
Callback URL
string
/ Required
callbackUrl
This is usually a reference to another flow's webhook URL
Connection
connection
/ Required
connection
 
 
Webhook Name
string
/ Required
name
 
Sheet ID
string
/ Required
scopeObjectId
 

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.

{
  "data": {
    "message": "UNCHANGED",
    "resultCode": 0,
    "result": {
      "id": 8951687911106436,
      "name": "Example Webhook",
      "apiClientId": "ixubfhznhzs4qmmurvm",
      "apiClientName": "Example Test App",
      "scope": "sheet",
      "scopeObjectId": 285065612683140,
      "subscope": {
        "columnIds": []
      },
      "events": [
        "*.*"
      ],
      "callbackUrl": "https://hooks.example.com/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
Connection
connection
/ Required
connection
 
 
Workspace Name
string
/ Required
name
 
New Workspace

{
  "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
Column ID
string
/ Required
columnId
 
Connection
connection
/ Required
connection
 
Sheet ID
string
/ Required
sheetId
 

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

Delete Comment​

Delete a comment by ID | key: commentDelete

InputNotes
Comment ID
string
/ Required
commentId
 
Connection
connection
/ Required
connection
 
Sheet ID
string
/ Required
sheetId
 

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

Delete Discussion​

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

InputNotes
Connection
connection
/ Required
connection
 
Discussion ID
string
/ Required
discussionId
 
Sheet ID
string
/ Required
sheetId
 

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

Delete Folder​

Delete Folder | key: deleteFolder

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

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

Delete Instance Webhooks​

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

InputNotes
Connection
connection
/ Required
connection
 

{
  "data": null
}

Delete Row​

Delete Row | key: deleteRow

InputNotes
Connection
connection
/ Required
connection
 
Row ID
string
/ Required
rowId
 
Sheet ID
string
/ Required
sheetId
 

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

Delete Sheet​

Delete Sheet | key: deleteSheet

InputNotes
Connection
connection
/ Required
connection
 
Sheet ID
string
/ Required
sheetId
 

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

Delete Webhook​

Delete webhook | key: deleteWebhook

InputNotes
Connection
connection
/ Required
connection
 
Webhook ID
string
/ Required
webhookId
 

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

Delete Workspace​

Delete Workspace | key: deleteWorkspace

InputNotes
Connection
connection
/ Required
connection
 
Workspace ID
string
/ Required
workspaceId
 

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

Edit Comment​

Edit a comment by ID | key: commentEdit

InputNotes
Comment ID
string
/ Required
commentId
 
Connection
connection
/ Required
connection
 
Sheet ID
string
/ Required
sheetId
 
Text
string
/ Required
text
 

{
  "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
Column ID
string
/ Required
columnId
 
Connection
connection
/ Required
connection
 
Sheet ID
string
/ Required
sheetId
 

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

Get Comment​

Get a comment by ID | key: commentGet

InputNotes
Comment ID
string
/ Required
commentId
 
Connection
connection
/ Required
connection
 
Sheet ID
string
/ Required
sheetId
 

{
  "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
Connection
connection
/ Required
connection
 
Contact ID
string
/ Required
contactId
contactId of the contact being accessed

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

Get Discussion​

Get discussion by ID | key: discussionGet

InputNotes
Connection
connection
/ Required
connection
 
Discussion ID
string
/ Required
discussionId
 
Sheet ID
string
/ Required
sheetId
 

{
  "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
Connection
connection
/ Required
connection
 
Folder ID
string
/ Required
folderId
Folder ID where you can create sheets, sights, reports, templates, and other folders

{
  "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
Connection
connection
/ Required
connection
 
Group ID
string
/ Required
groupId
 

{
  "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
Connection
connection
/ Required
connection
 
 
Pagination Page
string
page
1
Which page to return
Pagination Page Size
string
pageSize
100
The maximum number of items to return per page
Report ID
string
/ Required
reportId
 

Get Reports​

Get Reports | key: getReports

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

{
  "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
Connection
connection
/ Required
connection
 
Row ID
string
/ Required
rowId
 
Sheet ID
string
/ Required
sheetId
 

{
  "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": "example@company.com"
    },
    "modifiedAt": "2022-06-23T20:05:07Z",
    "modifiedBy": {
      "email": "example@company.com"
    },
    "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": "example@company.com",
        "objectValue": {
          "objectType": "CONTACT",
          "email": "example@company.com",
          "name": "example@company.com"
        },
        "displayValue": "example@company.com"
      },
      {
        "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
Connection
connection
/ Required
connection
 
 
Pagination Page
string
page
1
Which page to return
Pagination Page Size
string
pageSize
100
The maximum number of items to return per page
Sheet ID
string
/ Required
sheetId
 

{
  "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
Attachment ID
string
/ Required
attachmentId
 
Connection
connection
/ Required
connection
 
Sheet ID
string
/ Required
sheetId
 

{
  "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
Connection
connection
/ Required
connection
 
Sheet ID
string
/ Required
sheetId
 

{
  "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
Connection
connection
/ Required
connection
 
Sheet ID
string
/ Required
sheetId
 

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

Get User​

Get User | key: getUser

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

{
  "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
Connection
connection
/ Required
connection
 
Webhook ID
string
/ Required
webhookId
 

{
  "data": {
    "id": 8951687911106436,
    "name": "Example Webhook",
    "apiClientId": "ixubfhznhzs4qmmurvm",
    "apiClientName": "Example Test App",
    "scope": "sheet",
    "scopeObjectId": 285065612683140,
    "subscope": {
      "columnIds": []
    },
    "events": [
      "*.*"
    ],
    "callbackUrl": "https://hooks.example.com/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
Connection
connection
/ Required
connection
 
 
Load All
boolean
loadAll
false
Set to true to see nested folders
Workspace ID
string
/ Required
workspaceId
 

{
  "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
Connection
connection
/ Required
connection
 
 
Include All
boolean
includeAll
true
If true, include all results. Do not paginate.
Pagination Page
string
page
1
Which page to return
Pagination Page Size
string
pageSize
100
The maximum number of items to return per page
Row ID
string
/ Required
rowId
 
Sheet ID
string
/ Required
sheetId
 

{
  "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
Connection
connection
/ Required
connection
 
 
Include All
boolean
includeAll
true
If true, include all results. Do not paginate.
Pagination Page
string
page
1
Which page to return
Pagination Page Size
string
pageSize
100
The maximum number of items to return per page
Sheet ID
string
/ Required
sheetId
 

{
  "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
Connection
connection
/ Required
connection
 
 
Include All
boolean
includeAll
true
If true, include all results. Do not paginate.
Pagination Page
string
page
1
Which page to return
Pagination Page Size
string
pageSize
100
The maximum number of items to return per page
Sheet ID
string
/ Required
sheetId
 

{
  "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
Connection
connection
/ Required
connection
 
 
Include All
boolean
includeAll
true
If true, include all results. Do not paginate.
Pagination Page
string
page
1
Which page to return
Pagination Page Size
string
pageSize
100
The maximum number of items to return per page

{
  "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
Connection
connection
/ Required
connection
 
 
Discussion ID
string
/ Required
discussionId
 
Include All
boolean
includeAll
true
If true, include all results. Do not paginate.
Pagination Page
string
page
1
Which page to return
Pagination Page Size
string
pageSize
100
The maximum number of items to return per page
Sheet ID
string
/ Required
sheetId
 

{
  "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
Connection
connection
/ Required
connection
 
 
Include All
boolean
includeAll
true
If true, include all results. Do not paginate.
Pagination Page
string
page
1
Which page to return
Pagination Page Size
string
pageSize
100
The maximum number of items to return per page
Row ID (Optional)
string
rowId
 
Sheet ID
string
/ Required
sheetId
 

{
  "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
Connection
connection
/ Required
connection
 
 
 
Max Count
string
maxCount
1000
Maximum number of events to return as response to this call
 
Since
string
since
2010-01-01T00:00:00Z
Starting time for events to return
 
Stream Position
string
streamPosition
Indicates next set of events to return
XyzAb1234cdefghijklmnofpq

{
  "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
Connection
connection
/ Required
connection
 
 
Include All
boolean
includeAll
true
If true, include all results. Do not paginate.
Pagination Page
string
page
1
Which page to return
Pagination Page Size
string
pageSize
100
The maximum number of items to return per page

{
  "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
Connection
connection
/ Required
connection
 
 
Folder ID
string
folderId
Enter the ID of a folder to list subfolders, or omit this value to list top-level home folders.
Include All
boolean
includeAll
true
If true, include all results. Do not paginate.
Pagination Page
string
page
1
Which page to return
Pagination Page Size
string
pageSize
100
The maximum number of items to return per page
Workspace ID (Optional)
string
workspaceId
Create in this workspace. Optional.

{
  "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
Connection
connection
/ Required
connection
 
 
Include All
boolean
includeAll
true
If true, include all results. Do not paginate.
Modified Since
string
modifiedSince
When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified
Pagination Page
string
page
1
Which page to return
Pagination Page Size
string
pageSize
100
The maximum number of items to return per page

{
  "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
Connection
connection
/ Required
connection
 

{
  "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
Connection
connection
/ Required
connection
 
 
Include All
boolean
includeAll
true
If true, include all results. Do not paginate.
Modified Since
string
modifiedSince
When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified
Pagination Page
string
page
1
Which page to return
Pagination Page Size
string
pageSize
100
The maximum number of items to return per page

{
  "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
Connection
connection
/ Required
connection
 
 
Email
string
email
Find a user with this email address
Include All
boolean
includeAll
true
If true, include all results. Do not paginate.
Modified Since
string
modifiedSince
When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified
Pagination Page
string
page
1
Which page to return
Pagination Page Size
string
pageSize
100
The maximum number of items to return per page

{
  "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
Connection
connection
/ Required
connection
 
 
Show All
boolean
showAll
false
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).

{
  "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
Connection
connection
/ Required
connection
 
 
Include All
boolean
includeAll
true
If true, include all results. Do not paginate.
Pagination Page
string
page
1
Which page to return
Pagination Page Size
string
pageSize
100
The maximum number of items to return per page

{
  "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
Connection
connection
/ Required
connection
 
Destination Folder ID
string
/ Required
destinationId
Folder ID where you can create sheets, sights, reports, templates, and other folders
Folder ID
string
/ Required
folderId
Folder ID where you can create sheets, sights, reports, templates, and other folders

{
  "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
Connection
connection
/ Required
connection
 
 
Row IDs
string
Value List
rowIds
The Ids of the rows to move or copy from the source sheet
6830028284938
Sheet ID
string
/ Required
sheetId
 
 
Destination Sheet ID
string
/ Required
toSheetId
 
 

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

Move Sheet​

Move Sheet | key: moveSheet

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

{
  "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​

Send raw HTTP request to Smartsheet | key: rawRequest

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Data
string
data
The HTTP body payload to send to the URL.
{"exampleKey": "Example Data"}
Debug Request
boolean
debugRequest
false
Enabling this flag will log out the current request.
 
File Data
string
Key Value List
fileData
File Data to be sent as a multipart form upload.
[{key: "example.txt", value: "My File Contents"}]
File Data File Names
string
Key Value List
fileDataFileNames
File names to apply to the file data inputs. Keys must match the file data keys above.
 
Form Data
string
Key Value List
formData
The Form Data to be sent as a multipart form upload.
[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header
string
Key Value List
headers
A list of headers to send with the request.
User-Agent: curl/7.64.1
Max Retry Count
string
maxRetries
0
The maximum number of retries to attempt. Specify 0 for no retries.
 
Method
string
/ Required
method
The HTTP method to use.
 
Query Parameter
string
Key Value List
queryParams
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.
 
Response Type
string
/ Required
responseType
json
The type of data you expect in the response. You can request json, text, or binary data.
 
Retry On All Errors
boolean
retryAllErrors
false
If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.
 
Retry Delay (ms)
string
retryDelayMS
0
The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.
 
Timeout
string
timeout
The maximum time that a client will await a response to its request
2000
URL
string
/ Required
url
Input the path only (/reports), The base URL is already included (https://api.smartsheet.com/2.0). For example, to connect to https://api.smartsheet.com/2.0/reports, only /reports is entered in this field.
/reports
Use Exponential Backoff
boolean
useExponentialBackoff
false
Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.
 

Search Sheets​

Search sheets for a particular phrase | key: searchSheet

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

{
  "data": {
    "results": [
      {
        "contextData": [
          "Row 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
CC Me
boolean
ccMe
false
Indicates whether to send a copy of the email to the sender
Connection
connection
/ Required
connection
 
 
Emails
string
Value List
emails
Send the document to these email addresses
Format
string
/ Required
format
EXCEL
 
Group IDs
string
Value List
groups
Send the document to these groups by group ID
Message
string
message
The message of the email
Paper Size
string
/ Required
paperSize
LETTER
 
Sheet ID
string
/ Required
sheetId
 
Subject
string
subject
The subject of the email

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

Set Sheet Publish​

Set Sheet Publish Status | key: setSheetPublish

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

{
  "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
Connection
connection
/ Required
connection
 
 
Include All
boolean
includeAll
true
If true, include all results. Do not paginate.
Pagination Page
string
page
1
Which page to return
Pagination Page Size
string
pageSize
100
The maximum number of items to return per page

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

Templates List Public​

List Public Templates | key: templatesListPublic

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

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

Update Folder​

Update folder name | key: updateFolder

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

{
  "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
Connection
connection
/ Required
connection
 
New Name
string
/ Required
name
 
Sheet ID
string
/ Required
sheetId
 

{
  "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
Connection
connection
/ Required
connection
 
Name
string
/ Required
name
Workspace name
Workspace ID
string
/ Required
workspaceId
 

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