Connectors Reference
Smartsheet is a powerful work management and collaboration tool that lets you easily track and manage your work so you and your team can be more productive than ever. Use it to collaborate with others, track progress on any project, automate processes, and better structure your work.
|
Status: Production |
Tier: Standard |
Version: 1.0 |
|
Name |
Summary |
|
List the sheets |
|
|
Get a sheet |
|
|
Get the columns of a sheet |
|
|
Get the columns of a sheet (dynamic schema) |
|
|
Get a sheet data (dynamic schema) |
|
|
Insert row |
|
|
Gets the root folder for the file picker |
|
|
Get subfolders of a folder |
|
|
Gets a folders items for the file picker |
|
|
Get discussions for a sheet |
|
|
AddDiscussionToSheet (string sheetId, Discussion discussion) |
Add a discussion to a sheet |
|
AddDiscussionToRow (string sheetId, string rowId, Discussion discussion) |
Add a discussion to a row |
|
AddCommentToDiscussion (string sheetId, string discussionId, Comment comment) |
Add a comment to a discussion |
|
Get a discussion |
|
Name |
Summary |
|
When a new sheet is created |
|
|
When any sheet is updated |
|
|
When a comment is added to a sheet |
|
|
OnUpdatedSpecificSheet (string sheetId, [Optional]string columns) |
When a sheet is updated |
|
When a new row is created |
|
|
When a comment is added to a discussion |
|
|
When a discussion is added to a sheet |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: List the sheets
Description: Get a list of the sheets.
Syntax:
Smartsheet.ListSheets ([Optional]string optionalFolderId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
optionalFolderId |
string (Folder Id (defaults to all)) |
The unique id of the folder containing the sheets. If not specified, will default to all. |
False |
Returns:
Type:SmartsheetCollection[Sheet]
Description: A common pattern for requesting collections from Smartsheet.
Summary: Get a sheet
Description: Get a specific sheet.
Syntax:
Smartsheet.GetSheet (string sheetId, [Optional]string columns)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
sheetId |
string (Sheet Id) |
The unique id of the sheet. |
True |
|
|
columns |
string (Comma separated columns to return) |
The list of columns to return |
False |
Returns:
Type:SheetWithRows
Description: A Smartsheet sheet with rows.
Summary: Get the columns of a sheet
Description: Get the columns of a specific sheet.
Syntax:
Smartsheet.GetColumns (string sheetId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
sheetId |
string (Sheet Id) |
The unique id of the sheet. |
True |
Returns:
Type:SmartsheetCollection[Column]
Description: A common pattern for requesting collections from Smartsheet.
Summary: Get the columns of a sheet (dynamic schema)
Description: Get the columns of a specific sheet in dynamic schema format.
Syntax:
Smartsheet.GetColumnsSchema (string sheetId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
sheetId |
string (Sheet Id) |
The unique id of the sheet. |
True |
Returns:
Summary: Get a sheet data (dynamic schema)
Description: Get a specific sheet data.
Syntax:
Smartsheet.GetSheetData (string sheetId, [Optional]string columns)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
sheetId |
string (Sheet Id) |
The unique id of the sheet. |
True |
|
|
columns |
string (Comma separated columns to return) |
The list of columns to return |
False |
Returns:
Type:RowsList
Description: List of rows
Summary: Insert row
Description: Insert a row into a specific sheet.
Syntax:
Smartsheet.InsertRow (string sheetId, RowPost row)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
sheetId |
string (Sheet Id) |
The unique id of the sheet. |
True |
|
|
row |
|
An object that represents the posting of a row. |
True |
Returns:
Type:InsertRowResponse
Description: Response to InsertRow operation.
Summary: Gets the root folder for the file picker
Description: Gets the root folder for the file picker
Syntax:
Smartsheet.ListAllRootFolders ()
Returns:
Type:array of (BlobMetaData)
Summary: Get subfolders of a folder
Description: Get subfolders of a specific folder.
Syntax:
Smartsheet.ListSubFolders (string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Folder Id) |
The id of the folder. |
True |
Returns:
Type:SmartsheetCollection[Folder]
Description: A common pattern for requesting collections from Smartsheet.
Summary: Gets a folders items for the file picker
Description: Gets a folders items for the file picker
Syntax:
Smartsheet.ListFolder (string id)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
id |
string (Root Folder) |
The id of the parent folder |
True |
Returns:
Type:array of (BlobMetaData)
Summary: Get discussions for a sheet
Description: Get the discussions for a specific sheet.
Syntax:
Smartsheet.GetDiscussionsForSheet (string sheetId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
sheetId |
string (Sheet Id) |
The unique id of the sheet. |
True |
Returns:
Type:SmartsheetCollection[GetDiscussionResponse]
Description: A common pattern for requesting collections from Smartsheet.
Summary: Add a discussion to a sheet
Description: Add a discussion to a sheet
Syntax:
Smartsheet.AddDiscussionToSheet (string sheetId, Discussion discussion)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
sheetId |
string (Sheet Id) |
Sheet to add a discussion to |
True |
|
|
discussion |
|
A Smartsheet discussion. |
True |
Returns:
Type:DiscussionResponse
Description: Response object for Create Discussion.
Summary: Add a discussion to a row
Description: Add a discussion to a specific row in a sheet.
Syntax:
Smartsheet.AddDiscussionToRow (string sheetId, string rowId, Discussion discussion)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
sheetId |
string (Sheet) |
The unique id of the sheet. |
True |
|
|
rowId |
string (Row Id) |
The unique id of the row. |
True |
|
|
discussion |
|
A Smartsheet discussion. |
True |
Returns:
Type:DiscussionResponse
Description: Response object for Create Discussion.
Summary: Add a comment to a discussion
Description: Add a comment to an existing discussion.
Syntax:
Smartsheet.AddCommentToDiscussion (string sheetId, string discussionId, Comment comment)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
sheetId |
string (Sheet Id) |
The unique id of the sheet. |
True |
|
|
discussionId |
string (Discussion) |
The discussion to add the comment to. |
True |
|
|
comment |
|
A discussion comment. |
True |
Returns:
Description: Response object for Creating a Comment.
Summary: Get a discussion
Description: Get a specific discussion.
Syntax:
Smartsheet.GetDiscussion (string sheetId, string discussionId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
sheetId |
string (Sheet Id) |
The unique id of the sheet. |
True |
|
|
discussionId |
string (Discussion Id) |
The unique id of the discussion on the specified sheet. |
True |
Returns:
Type:DiscussionData
Description: Data relevant to the discussion created.
Summary: When a new sheet is created
Description: Triggers when a new sheet is created.
Syntax:
Smartsheet.OnNewSheet ([Optional]string optionalFolderId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
optionalFolderId |
string (Folder Id (defaults to all)) |
The unique id of the folder containing the sheets. If not specified, will default to all. |
False |
Returns:
Type:SmartsheetCollection[Sheet]
Description: A common pattern for requesting collections from Smartsheet.
Summary: When any sheet is updated
Description: Triggers when any sheet is updated.
Syntax:
Smartsheet.OnUpdatedSheet ([Optional]string optionalFolderId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
optionalFolderId |
string (Folder (defaults to all)) |
The unique id of the folder containing the sheets. If not specified, will default to all. |
False |
Returns:
Type:SmartsheetCollection[Sheet]
Description: A common pattern for requesting collections from Smartsheet.
Summary: When a comment is added to a sheet
Description: Triggers when a comment is added to a specific sheet.
Syntax:
Smartsheet.OnNewComment (string sheetId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
sheetId |
string (Sheet Id) |
The unique id of the sheet. |
True |
Returns:
Type:SmartsheetCollection[DiscussionComment]
Description: A common pattern for requesting collections from Smartsheet.
Summary: When a sheet is updated
Description: Triggers when a specific sheet is updated.
Syntax:
Smartsheet.OnUpdatedSpecificSheet (string sheetId, [Optional]string columns)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
sheetId |
string (Sheet Id) |
The unique id of the sheet. |
True |
|
|
columns |
string (Columns to Return) |
The comma separateed list of columns to return. |
False |
Returns:
Type:SmartsheetCollection[SheetWithRows]
Description: A common pattern for requesting collections from Smartsheet.
Summary: When a new row is created
Description: Triggers when a new row is created in a specific sheet.
Syntax:
Smartsheet.OnRowCreated (string sheetId, [Optional]string columns)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
sheetId |
string (Sheet Id) |
The unique id of the sheet. |
True |
|
|
columns |
string (Columns) |
The comma separated list of columns. |
False |
Returns:
Type:RowResponse
Description: Response object for OnRowCreated.
Summary: When a comment is added to a discussion
Description: Triggers when a comment is added to a specific discussion.
Syntax:
Smartsheet.OnCommentAdded (string sheetId, string discussionId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
sheetId |
string (Sheet Id) |
The unique id of the sheet. |
True |
|
|
discussionId |
string (Discussion Id) |
The unique id of the discussion. |
True |
Returns:
Type:CommentResponse
Description: Response object for Comment.
Summary: When a discussion is added to a sheet
Description: Triggers when a discussion is added to a sheet.
Syntax:
Smartsheet.OnDiscussionCreated (string sheetId)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
sheetId |
string (Sheet Id) |
The unique id of the sheet. |
True |
Returns:
Type:SmartsheetCollection[GetDiscussionResponse]
Description: A common pattern for requesting collections from Smartsheet.
Summary:
Description: Metadata for Smartsheet Blobs.
Properties:
|
Name |
Type |
Summary |
|
Id |
string Id |
The unique identifier for the file or folder. |
|
Name |
string Name |
The name of the file or folder. |
|
DisplayName |
string Display Name |
The display name of the file or folder. |
|
Path |
string Path |
The path of the file or folder. |
|
LastModified |
string(date-time) Modified At |
The last modified datetime of the file or folder. |
|
Size |
integer(int64) Size |
The size of the file or folder. |
|
MediaType |
string Media Type |
The MIME media type of the file. |
|
IsFolder |
boolean Is Folder |
A boolean value (true, false) determining whether or not the item is a folder. |
|
ETag |
string ETag |
The ETag, a token used for syncing. |
|
FileLocator |
string File Locator |
The file locator (API use only). |
Summary:
Description: A Smartsheet column.
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int64) Column Id |
The unique id of the column. |
|
index |
integer(int32) Column Index |
The ordinal position of the column. |
|
title |
string Title |
The title of the column. |
|
type |
string Data Type |
The data type of the column (such as text_number or datetime). |
|
primary |
boolean Is Primary |
A boolean value (true, false) determining whether or not the column is the primary column. |
|
width |
integer(int32) Width |
The width in pixels of the column, |
Summary:
Description: A discussion comment.
Properties:
|
Name |
Type |
Summary |
|
text |
string Text |
The text of the comment. |
Summary:
Description: Response object for Comment.
Properties:
|
Name |
Type |
Summary |
|
comments |
array of (DiscussionComment) Comments |
Comments in this discussion. |
Summary:
Description: Response object for Creating a Comment.
Properties:
|
Name |
Type |
Summary |
|
result |
|
A comment on a discussion. |
Summary:
Description: A Smartsheet discussion.
Properties:
|
Name |
Type |
Summary |
|
title |
string Title |
The title for the discussion. |
|
comment |
|
A discussion comment. |
Summary:
Description: A comment on a discussion.
Properties:
|
Name |
Type |
Summary |
|
text |
string Comment Text |
The text of the comment. |
|
id |
integer(int32) Comment Id |
The id for the comment. |
|
createdBy |
|
The user who created the comment. |
|
createdAt |
string(date-time) Created At |
The datetime the comment was created. |
|
modifiedAt |
string(date-time) Modified At |
The datetime the comment was modified. |
Summary:
Description: The user who created the comment.
Properties:
|
Name |
Type |
Summary |
|
name |
string Created By (Name) |
The name of the user who created a comment. |
|
|
string Created By (Email) |
The email of the user who created a comment. |
Summary:
Description: Data relevant to the discussion created.
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Id of Discussion |
The id for the discussion. |
|
title |
string Discussion title |
The title for the discussion. |
|
comments |
array of (DiscussionComment) Comments |
The comments in the discussion. |
|
createdBy |
|
The user who created the discussion. |
Summary:
Description: Response object for Create Discussion.
Properties:
|
Name |
Type |
Summary |
|
result |
|
Data relevant to the discussion created. |
Summary:
Description: The user who created the discussion.
Properties:
|
Name |
Type |
Summary |
|
name |
string Created By (Name) |
The name of the user who created the discussion. |
|
|
string Created By (Email) |
The email of the user who created the discussion. |
Summary:
Description: A Smartsheet folder.
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int64) Id |
The unique id of the folder. |
|
name |
string Name |
The name of the folder. |
|
permalink |
string Url |
The url for the folder. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Response object for Get Discussions.
Properties:
|
Name |
Type |
Summary |
|
id |
integer(int32) Discussion Id |
The unique id of the discussion. |
|
title |
string Discussion Title |
The title for the discussion. |
|
createdBy |
|
The user who created the discussion. |
|
accessLevel |
string Access Level |
The access Level for the discussion. |
|
parentType |
string Parent Type |
The parent type for the discussion. |
|
readOnly |
boolean Is Read-Only |
A boolean value (true, false) determining whether or not this discussion is read-only. |
|
lastCommentedAt |
string(date-time) Last Commented At |
The datetime of the most recent comment |
Summary:
Description: Response to InsertRow operation.
Properties:
|
Name |
Type |
Summary |
|
result |
|
|
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
sheetId |
integer(int32) Sheet Id |
The Id of the sheet that was modified. |
|
rowNumber |
integer(int32) Row Number |
The row number of the newly inserted row. |
|
createdAt |
string(date-time) Created At |
The datetime the sheet was created. |
|
modifiedAt |
string(date-time) Modified At |
The datetime the sheet was modified. |
Summary:
Description: A cell in a row
Properties:
|
Name |
Type |
Summary |
|
columnId |
integer Column Id |
The id of column for this cell. |
|
value |
Cell Value |
The value of the cell. |
|
displayValue |
string Cell Display Value |
The display value of the cell. |
Summary: Cell Value
Description: The value of the cell.
Properties:
|
Name |
Type |
Summary |
Summary:
Description: A row
Properties:
|
Name |
Type |
Summary |
|
id |
integer Row Id |
The unique id for the row. |
|
sheetId |
integer Sheet Id |
The id of the sheet the row was added to. |
|
permalink |
string Url |
The url for the sheet the row was added to. |
|
createdAt |
string(date-time) Created At |
The datetime the row was created. |
|
modifiedAt |
string(date-time) Modified At |
The datetime the row was modified. |
|
rowNumber |
integer(int32) Row Number |
The number of the row. |
|
cells |
array of (RowCell) Cells |
The cell detail in the row. |
|
rowHTML |
string Row HTML |
An HTML table representation of the new row. |
Summary:
Description: An object that represents the posting of a row.
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Response object for OnRowCreated.
Properties:
|
Name |
Type |
Summary |
|
rows |
array of (RowData) Rows |
The content of the row that was created. |
Summary:
Description: List of rows
Properties:
|
Name |
Type |
Summary |
|
value |
array of (RowPost)
|
List of rows |
Summary:
Description: A Smartsheet sheet.
Properties:
|
Name |
Type |
Summary |
|
accessLevel |
string Access Level |
The access level of the sheet. |
|
id |
integer(int32) Id |
The unique identifier for the sheet. |
|
name |
string Name |
The name of the sheet. |
|
permalink |
string Url |
The url for the sheet. |
|
createdAt |
string(date-time) Created At |
The datetime when the sheet was created. |
|
modifiedAt |
string(date-time) Modified At |
The datetime the sheet was modified. |
Summary:
Description: A Smartsheet sheet with rows.
Properties:
|
Name |
Type |
Summary |
|
rowHTML |
string Sheet HTML |
An HTML table representation of the sheet. |
|
accessLevel |
string Access Level |
The access level of the sheet. |
|
id |
integer(int32) Id |
The unique identifier for the sheet. |
|
name |
string Name |
The name of the sheet. |
|
permalink |
string Url |
The url for the sheet. |
|
createdAt |
string(date-time) Created At |
The datetime the sheet was created. |
|
modifiedAt |
string(date-time) Modified At |
The datetime the sheet was modified. |
|
columns |
array of (Column) Columns |
Array of columns. |
|
rows |
array of (RowData) Rows |
Array of rows. |
Summary:
Description: A common pattern for requesting collections from Smartsheet.
Properties:
|
Name |
Type |
Summary |
|
data |
array of (Column) Data |
Collection of Smartsheet models |
Summary:
Description: A common pattern for requesting collections from Smartsheet.
Properties:
|
Name |
Type |
Summary |
|
data |
array of (DiscussionComment) Data |
Collection of Smartsheet models. |
Summary:
Description: A common pattern for requesting collections from Smartsheet.
Properties:
|
Name |
Type |
Summary |
|
data |
array of (Folder) Data |
Collection of Smartsheet models. |
Summary:
Description: A common pattern for requesting collections from Smartsheet.
Properties:
|
Name |
Type |
Summary |
|
data |
array of (GetDiscussionResponse) Data |
Collection of Smartsheet models. |
Summary:
Description: A common pattern for requesting collections from Smartsheet.
Properties:
|
Name |
Type |
Summary |
|
data |
array of (SheetWithRows) Data |
Collection of Smartsheet models. |
Summary:
Description: A common pattern for requesting collections from Smartsheet.
Properties:
|
Name |
Type |
Summary |
|
data |
array of (Sheet) Data |
Collection of Smartsheet models. |