Introduction
API Basics
Assume User
Authentication and Access Tokens
Dates and Times
Filtering
Formatting
Formulas
HTTP and REST
HTTP Headers
HTTP Verbs
HTTP Status Codes
Limitations
Looping
Multi-contact or Multi-picklist: Working with Complex Objects
Object Details vs List Summaries
Query Strings
Raw Token Requests
SDKs and Sample Code
Sheets/Columns/Rows/Cells
Versioning and Changes
Code Walkthrough
Make Your First API Call
How to Read a Sheet Response
Error Code List
400-Level Error Codes
500-Level Error Codes
OAuth Walkthrough
First Steps
Open Developer Tools
Register Your App Using Developer Tools
OAuth Flow
Access Scopes
Request an Authorization Code
If the User Clicks Allow
If the User Clicks Deny
Get or Refresh an Access Token
OAuth Error Types
Resources
Security
Adding Security by Using OAuth
Access Levels
API Key Management
Source Code and Version control
Smartsheet Gov
Smartsheet Regions Europe
Troubleshooting
Work at Scale
Bulk Operations
Paging
Rate Limiting
Authentication
Alternate Emails
Alternate Email Addresses Basics
Objects
AlternateEmail Object
Methods
get
List Alternate Emails
post
Add Alternate Emails
get
Get Alternate Email
del
Delete Alternate Email
post
Make Alternate Email Primary
Attachments
Attachments Basics
Post an Attachment
Multipart Uploads
Simple Uploads
Objects
Attachment Object
URLAttachmentRequest Object
Methods
get
List Attachments
post
Attach File or URL to Sheet
get
Get Attachment
del
Delete Attachment
get
List Versions
post
Attach New version
del
Delete All Versions
post
Attach File or URL to Comment
get
List Discussion Attachments
get
List Row Attachments
post
Attach File or URL to Row
Automation Rules
Automation Rules Basics
Objects
AutomationRule Object
AutomationAction Object
Methods
get
List All Automation Rules
get
Get an Automation Rule
put
Update an Automation Rule
del
Delete an Automation Rule
Related Items
Disabled Reasons for Automation Rules
Cells
Cells Basics
Objects
Cell Object
CellHistory Object
CellLink Object
Duration Object
Hyperlink Object
ObjectValue Object
Predecessor Object
PredecessorList Object
Methods
get
List Cell History
Related Items
Cell Links
Cell Reference
Cell Value Representation
Cell Value Parsing
Contact List Columns
Hyperlinks
Images in Cells
Cell Images
Cell Images Basics
Objects
Image Object
Image Url Object
Image Url Map Object
Methods
post
List Image URLs
post
Add Image to Cell
Columns
Columns Basics
Objects
Column Object
ContactOption Object
Methods
get
List Columns
post
Add Columns
get
Get Column
del
Delete Column
put
Update Column
Related Items
Column Types
Symbol Columns
System Columns
Comments
Comments Basics
Objects
Comment Object
Methods
get
Get a comment
put
Edit a comment
del
Delete a comment
post
Create a comment
Related Items
Comment Attachments
Common Objects
Other Objects
AutoNumberFormat Object
BulkItemFailure Object
ContainerDestination Object
Currency Object
Error Object
FontFamily Object
FormatTables Object
IndexResult Object
Result Object
Contacts
Contacts Basics
Objects
Contact Object
Methods
get
List Contacts
get
Get Contact
Cross-sheet References
Cross-sheet References Basics
Objects
CrossSheetReference Object
Methods
post
Create Cross-sheet References
get
List Cross-sheet References
get
Get Cross-sheet Reference
Dashboards
Dashboards Basics
Objects
Dashboard Object
DashboardPublish Object
Widget Object
CellLinkWidgetContent Object
CellDataItem Object
ChartWidgetContent Object
ImageWidgetContent Object
ReportWidgetContent Object
RichTextWidgetContent Object
SelectionRange Object
ShortcutDataItem Object
ShortcutWidgetContent Object
TitleWidgetContent Object
WebContentWidgetContent Object
WidgetHyperlink Object
Methods
get
List Dashboards
get
Get Dashboard
put
Update Dashboard
del
Delete Dashboard
post
Copy Dashboard
post
Move Dashboard
put
Set Dashboard Publish Status
post
Share Dashboard
get
List Dashboard Shares
get
Get Dashboard Share
del
Delete Dashboard Share
put
Update Dashboard Share
Discussions
Discussions Basics
Objects
Discussion Object
Methods
get
List Discussions
post
Create a Discussion
get
Get Discussion
del
Delete a Discussion
get
List Discussions with a Row
post
Create a Discussion on a Row
Related Items
Discussion Attachments
Discussion Comments
Events
Events Basics
Objects
Event Object
StreamResult Object
Methods
get
List Events
Favorites
Favorites Basics
Objects
Favorite Object
Methods
get
Get Favorites
post
Add Favorites
del
Delete Multiple Favorites
del
Delete Favorite
get
Is Favorite
Folders
Folders Basics
Objects
Folder Object
Methods
get
Get Folder
del
Delete Folder
put
Update Folder
post
Copy Folder
get
List Folders
post
Create Folder
post
Move Folder
Groups
Groups Basics
Objects
Group Object
Methods
get
List Org Groups
post
Add Group
get
Get Group
put
Update Group
del
Delete Group
Group Members
Group Members Basics
Objects
Group Member Object
Methods
post
Add Group Members
del
Delete Group Members
Home
Home Basics
Objects
Home Object
Methods
get
List Contents
get
List Folders in Home
post
Create Folder
Related Items
Home Folders
Home Sheets
Import
Import Basics
Methods
post
Import Sheet into Folder
post
Import Sheet from CSV / XLSX
post
Import Sheet into Workspace
Proofs
Proofs Basics
Objects
Proof Object
ProofRequest Object
ProofRequestAction Object
Methods
get
List Proofs
get
Get Proof
del
Delete Proof
put
Update Proof Status
get
List Proof Attachments
post
Attach File to Proof
get
List Proof Discussions
post
Create Proof Discussion
get
List Proof Request Actions
del
Delete Proof Requests
post
Create Proof Request
get
List Proof Versions
del
Delete Proof Version
post
Create Proof Version
post
Create Proof
Reports
Reports Basics
Objects
Report Object
Report Cell Object
Report Column Object
Report Row Object
Report Publish Object
Scope Object
Methods
get
Get Reports
get
Get Report
post
Send report via email
get
Gets a Report's publish settings
put
Set a Report's publish status
post
Share Report
get
List Report Shares
get
Get Report Share.
del
Delete Report Share
put
Update Report Share.
Related Items
Report Attachments
Report Cells
Report Columns
Report Discussions
Report Rows
Rows
Rows Basics
Objects
Row Object
CopyOrMoveRowDestination Object
CopyOrMoveRowDirective Object
CopyOrMoveRowResult object
RowMapping Object
Methods
post
Add Rows
del
Delete Rows
put
Update Rows
post
Send Rows via Email
post
Copy Rows to Another Sheet
post
Move Rows to Another Sheet
get
Get Row
post
Sort Rows in Sheet
Related Items
Row Attachments
Row Cells
Row Discussions
Row Include Flags
Specify Row Location
Search
Search Basics
Objects
Search Result Object
Search Result Item Object
Methods
get
Search Everything
get
Search Sheet
Send Via Email
Send via Email Basics
Objects
Email Object
Format Details Object
Recipient Object
Row Email Object
Multi Row Email Object
Sheet Email Object
Methods
Send Report
Send Rows
Send Sheet
Send Update Request
Server Information
Server Info Basics
Objects
Server Info Object
Methods
get
Gets application constants.
Sharing
Sharing Basics
Objects
Share Object
Methods
post
Share Report
get
List Report Shares
get
Get Report Share.
del
Delete Report Share
put
Update Report Share.
post
Share Sheet
get
List Sheet Shares
get
Get Sheet Share.
del
Delete Sheet Share
put
Update Sheet Share.
post
Share Dashboard
get
List Dashboard Shares
get
Get Dashboard Share
del
Delete Dashboard Share
put
Update Dashboard Share
post
Share Workspace
get
List Workspace Shares
get
Get Workspace Share.
del
Delete Workspace Share
put
Update Workspace Share.
Sheet Summary
Sheet Summary Basics
Objects
Sheet Summary Object
Summary Field Object
Methods
get
Get Sheet Summary
get
Get Summary Fields
put
Update Summary Fields
del
Delete Summary Fields
post
Add Summary Fields
post
Add Image to Sheet Summary
Sheets
Sheets Basics
Objects
Sheet Object
Criteria Object
Filters Object
ProjectSettings Object
SheetPublish Object
SheetUserPermissions Object
SheetUserSettings Object
SortCriterion Object
SortSpecifier Object
Source Object
Methods
post
Create Sheet in Folder
get
List Sheets
post
Create Sheet in "Sheets" Folder
get
Get Sheet
del
Delete Sheet
put
Update Sheet
post
Copy Sheet
post
Send Sheet via Email
post
Move Sheet
get
Get Sheet Publish Status
put
Set Sheet Publish Status
post
Share Sheet
get
List Sheet Shares
get
Get Sheet Share.
del
Delete Sheet Share
put
Update Sheet Share.
get
Get Sheet Version
get
List Org Sheets
post
Create Sheet in Workspace
Related Items
Sheet Attachments
Sheet Cells
Sheet Columns
Sheet Discussions
Sheet Rows
Templates
Templates Basics
Objects
Template Object
Methods
get
List User-Created Templates
get
List Public Templates
Token
Token Basics
Token Objects
Token Object
Token Methods
post
Gets or Refreshes an Access Token
del
Revoke Access Token
Update Requests
Update Requests Basics
Objects
UpdateRequest Object
SentUpdateRequest Object
Schedule Object
Methods
get
List Sent Update Requests
get
Get Sent Update Request
del
Delete Sent Update Request
get
List Update Requests
post
Create an Update Request
get
Get an Update Request
put
Update an Update Request
del
Delete an Update Request
Users
Users Basics
Objects
User Object
User Profile Object
Account Object
AlternateEmail Object
Methods
get
List Users
post
Add User
get
Get Current User
get
Get User
del
Remove User
put
Update User
post
Deactivate User
post
Update User Profile Image
post
Reactivate User
Webhooks
Webhooks Basics
Intro to Webhooks
Webhook Management
Webhook Ownership & Access
Webhook Scope & Events
Example
Creating a Webhook
Step-by-Step:
Webhook Verification
Duplicate Webhooks
Webhook Status
Webhook Callbacks
Event Callbacks
Callback Acknowledgement
Retry Logic
Status Change Callbacks
Authenticating Callbacks (optional)
Preventing Infinite Loops
Webhook Errors
Objects
Webhook Object
Callback Object
CallbackEvent Object
SharedSecret Object
Subscope Object
Methods
get
List Webhooks
post
Create Webhook
get
Get Webhook
put
Update Webhook
del
Delete Webhook
post
Reset Shared Secret
Workspaces
Workspaces Basics
Objects
Workspace Object
Methods
get
List Workspaces
post
Create Workspace
get
Get Workspace
del
Delete Workspace
put
Update Workspace
post
Copy Workspace
get
Get Workspace folders
post
Create a Folder
post
Share Workspace
get
List Workspace Shares
get
Get Workspace Share.
del
Delete Workspace Share
put
Update Workspace Share.
Related Items
Workspace Folders
Workspace Sheets
Server Info Basics
For developer convenience, the Smartsheet API provides access to application constants.
➔ Next to
Objects
