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
  - getList Alternate Emails
  - postAdd Alternate Emails
  - getGet Alternate Email
  - delDelete Alternate Email
  - postMake Alternate Email Primary
Attachments
- Attachments Basics
  - Post an Attachment
    - Multipart Uploads
    - Simple Uploads
- Objects
  - Attachment Object
  - URLAttachmentRequest Object
- Methods
  - getList Attachments
  - postAttach File or URL to Sheet
  - getGet Attachment
  - delDelete Attachment
  - getList Versions
  - postAttach New version
  - delDelete All Versions
  - postAttach File or URL to Comment
  - getList Discussion Attachments
  - getList Row Attachments
  - postAttach File or URL to Row
Automation Rules
- Automation Rules Basics
- Objects
  - AutomationRule Object
  - AutomationAction Object
- Methods
  - getList All Automation Rules
  - getGet an Automation Rule
  - putUpdate an Automation Rule
  - delDelete 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
  - getList 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
  - postList Image URLs
  - postAdd Image to Cell
Columns
- Columns Basics
- Objects
  - Column Object
  - ContactOption Object
- Methods
  - getList Columns
  - postAdd Columns
  - getGet Column
  - delDelete Column
  - putUpdate Column
- Related Items
  - Column Types
    - Symbol Columns
    - System Columns
Comments
- Comments Basics
- Objects
  - Comment Object
- Methods
  - getGet a comment
  - putEdit a comment
  - delDelete a comment
  - postCreate 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
  - getList Contacts
  - getGet Contact
Cross-sheet References
- Cross-sheet References Basics
- Objects
  - CrossSheetReference Object
- Methods
  - postCreate Cross-sheet References
  - getList Cross-sheet References
  - getGet 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
  - getList Dashboards
  - getGet Dashboard
  - putUpdate Dashboard
  - delDelete Dashboard
  - postCopy Dashboard
  - postMove Dashboard
  - putSet Dashboard Publish Status
  - postShare Dashboard
  - getList Dashboard Shares
  - getGet Dashboard Share
  - delDelete Dashboard Share
  - putUpdate Dashboard Share
Discussions
- Discussions Basics
- Objects
  - Discussion Object
- Methods
  - getList Discussions
  - postCreate a Discussion
  - getGet Discussion
  - delDelete a Discussion
  - getList Discussions with a Row
  - postCreate a Discussion on a Row
- Related Items
  - Discussion Attachments
  - Discussion Comments
Events
- Events Basics
- Objects
  - Event Object
  - StreamResult Object
- Methods
  - getList Events
Favorites
- Favorites Basics
- Objects
  - Favorite Object
- Methods
  - getGet Favorites
  - postAdd Favorites
  - delDelete Multiple Favorites
  - delDelete Favorite
  - getIs Favorite
Folders
- Folders Basics
- Objects
  - Folder Object
- Methods
  - getGet Folder
  - delDelete Folder
  - putUpdate Folder
  - postCopy Folder
  - getList Folders
  - postCreate Folder
  - postMove Folder
Groups
- Groups Basics
- Objects
  - Group Object
- Methods
  - getList Org Groups
  - postAdd Group
  - getGet Group
  - putUpdate Group
  - delDelete Group
Group Members
- Group Members Basics
- Objects
  - Group Member Object
- Methods
  - postAdd Group Members
  - delDelete Group Members
Home
- Home Basics
- Objects
  - Home Object
- Methods
  - getList Contents
  - getList Folders in Home
  - postCreate Folder
- Related Items
  - Home Folders
  - Home Sheets
Import
- Import Basics
- Methods
  - postImport Sheet into Folder
  - postImport Sheet from CSV / XLSX
  - postImport Sheet into Workspace
Proofs
- Proofs Basics
- Objects
  - Proof Object
  - ProofRequest Object
  - ProofRequestAction Object
- Methods
  - getList Proofs
  - getGet Proof
  - delDelete Proof
  - putUpdate Proof Status
  - getList Proof Attachments
  - postAttach File to Proof
  - getList Proof Discussions
  - postCreate Proof Discussion
  - getList Proof Request Actions
  - delDelete Proof Requests
  - postCreate Proof Request
  - getList Proof Versions
  - delDelete Proof Version
  - postCreate Proof Version
  - postCreate Proof
Reports
- Reports Basics
- Objects
  - Report Object
  - Report Cell Object
  - Report Column Object
  - Report Row Object
  - Report Publish Object
  - Scope Object
- Methods
  - getGet Reports
  - getGet Report
  - postSend report via email
  - getGets a Report's publish settings
  - putSet a Report's publish status
  - postShare Report
  - getList Report Shares
  - getGet Report Share.
  - delDelete Report Share
  - putUpdate 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
  - postAdd Rows
  - delDelete Rows
  - putUpdate Rows
  - postSend Rows via Email
  - postCopy Rows to Another Sheet
  - postMove Rows to Another Sheet
  - getGet Row
  - postSort 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
  - getSearch Everything
  - getSearch 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
  - getGets application constants.
Sharing
- Sharing Basics
- Objects
  - Share Object
- Methods
  - postShare Report
  - getList Report Shares
  - getGet Report Share.
  - delDelete Report Share
  - putUpdate Report Share.
  - postShare Sheet
  - getList Sheet Shares
  - getGet Sheet Share.
  - delDelete Sheet Share
  - putUpdate Sheet Share.
  - postShare Dashboard
  - getList Dashboard Shares
  - getGet Dashboard Share
  - delDelete Dashboard Share
  - putUpdate Dashboard Share
  - postShare Workspace
  - getList Workspace Shares
  - getGet Workspace Share.
  - delDelete Workspace Share
  - putUpdate Workspace Share.
Sheet Summary
- Sheet Summary Basics
- Objects
  - Sheet Summary Object
  - Summary Field Object
- Methods
  - getGet Sheet Summary
  - getGet Summary Fields
  - putUpdate Summary Fields
  - delDelete Summary Fields
  - postAdd Summary Fields
  - postAdd 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
  - postCreate Sheet in Folder
  - getList Sheets
  - postCreate Sheet in "Sheets" Folder
  - getGet Sheet
  - delDelete Sheet
  - putUpdate Sheet
  - postCopy Sheet
  - postSend Sheet via Email
  - postMove Sheet
  - getGet Sheet Publish Status
  - putSet Sheet Publish Status
  - postShare Sheet
  - getList Sheet Shares
  - getGet Sheet Share.
  - delDelete Sheet Share
  - putUpdate Sheet Share.
  - getGet Sheet Version
  - getList Org Sheets
  - postCreate Sheet in Workspace
- Related Items
  - Sheet Attachments
  - Sheet Cells
  - Sheet Columns
  - Sheet Discussions
  - Sheet Rows
Templates
- Templates Basics
- Objects
  - Template Object
- Methods
  - getList User-Created Templates
  - getList Public Templates
Token
- Token Basics
- Token Objects
  - Token Object
- Token Methods
  - postGets or Refreshes an Access Token
  - delRevoke Access Token
Update Requests
- Update Requests Basics
- Objects
  - UpdateRequest Object
  - SentUpdateRequest Object
  - Schedule Object
- Methods
  - getList Sent Update Requests
  - getGet Sent Update Request
  - delDelete Sent Update Request
  - getList Update Requests
  - postCreate an Update Request
  - getGet an Update Request
  - putUpdate an Update Request
  - delDelete an Update Request
Users
- Users Basics
- Objects
  - User Object
  - User Profile Object
  - Account Object
  - AlternateEmail Object
- Methods
  - getList Users
  - postAdd User
  - getGet Current User
  - getGet User
  - delRemove User
  - putUpdate User
  - postDeactivate User
  - postUpdate User Profile Image
  - postReactivate 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
  - getList Webhooks
  - postCreate Webhook
  - getGet Webhook
  - putUpdate Webhook
  - delDelete Webhook
  - postReset Shared Secret
Workspaces
- Workspaces Basics
- Objects
  - Workspace Object
- Methods
  - getList Workspaces
  - postCreate Workspace
  - getGet Workspace
  - delDelete Workspace
  - putUpdate Workspace
  - postCopy Workspace
  - getGet Workspace folders
  - postCreate a Folder
  - postShare Workspace
  - getList Workspace Shares
  - getGet Workspace Share.
  - delDelete Workspace Share
  - putUpdate Workspace Share.
- Related Items
  - Workspace Folders
  - Workspace Sheets

Rows Basics

A row is a component of a sheet or report. Each row is composed of a collection of cells, and may optionally contain discussions or attachments.

➔ Next to Objects