Skip to main content

​
What can you do with it?

Manage your spreadsheets and data with Smartsheet, including retrieving all sheets, reading sheet data, managing rows and columns, and handling spreadsheet operations for efficient data organization and collaboration within the Smartsheet platform.

​
How to use it?

​
Basic Command Structure

/your-smartsheet-connection [action] [required-parameters] [optional-parameters]

​
Parameters

Required:
  • action - The operation to perform (get-all-sheets, get-sheet-data)
Optional:
  • sheet-id - Smartsheet sheet ID
  • include-columns - Include column information
  • include-rows - Include row information

​
Tools

​
Get All Sheets

Retrieve a list of all your Smartsheet sheets Parameters:
  • No parameters required
Example: 
/your-smartsheet-connection
action: get-all-sheets
Response: 
{
  "data": [
    {
      "id": 4583173393803140,
      "name": "sheet1",
      "accessLevel": "OWNER",
      "permalink": "https://app.smartsheet.com/sheets/VtqiTExBWDqy4T4xncrHqhQ",
      "createdAt": "2016-06-29T21:32:52Z",
      "modifiedAt": "2016-06-29T21:32:52Z"
    },
    {
      "id": 2331373580117892,
      "name": "Copy of sheet1",
      "accessLevel": "OWNER",
      "permalink": "https://app.smartsheet.com/sheets/WtqiTExBWDqy4T4xncrHqhQ",
      "createdAt": "2016-06-29T21:33:05Z",
      "modifiedAt": "2016-06-29T21:33:05Z"
    }
  ],
  "totalCount": 2,
  "pageNumber": 1,
  "pageSize": 100,
  "totalPages": 1
}

​
Get Sheet Data

Read data from a specific Smartsheet sheet Parameters:
  • sheet-id (required) - Smartsheet sheet ID
  • include-columns (optional) - Include column information (default: true)
  • include-rows (optional) - Include row information (default: true)
Example: 
/your-smartsheet-connection
action: get-sheet-data
sheet-id: 4583173393803140
include-columns: true
include-rows: true
Response: 
{
  "id": 4583173393803140,
  "name": "sheet1",
  "version": 1,
  "totalRowCount": 100,
  "accessLevel": "OWNER",
  "effectiveAttachmentOptions": ["GOOGLE_DRIVE", "LINK", "FILE"],
  "ganttEnabled": false,
  "dependenciesEnabled": false,
  "resourceManagementEnabled": false,
  "cellLinkingEnabled": false,
  "createdAt": "2016-06-29T21:32:52Z",
  "modifiedAt": "2016-06-29T21:32:52Z",
  "columns": [
    {
      "id": 7960873114331012,
      "version": 0,
      "index": 0,
      "title": "Primary Column",
      "type": "TEXT_NUMBER",
      "primary": true,
      "width": 150
    },
    {
      "id": 642523719853956,
      "version": 0,
      "index": 1,
      "title": "Column2",
      "type": "TEXT_NUMBER",
      "width": 150
    }
  ],
  "rows": [
    {
      "id": 6572401924865924,
      "rowNumber": 1,
      "version": 0,
      "createdAt": "2016-06-29T21:32:52Z",
      "modifiedAt": "2016-06-29T21:32:52Z",
      "cells": [
        {
          "columnId": 7960873114331012,
          "value": "Sample Value 1",
          "displayValue": "Sample Value 1"
        },
        {
          "columnId": 642523719853956,
          "value": "Sample Value 2",
          "displayValue": "Sample Value 2"
        }
      ]
    },
    {
      "id": 1068202310180740,
      "rowNumber": 2,
      "version": 0,
      "createdAt": "2016-06-29T21:32:52Z",
      "modifiedAt": "2016-06-29T21:32:52Z",
      "cells": [
        {
          "columnId": 7960873114331012,
          "value": "Sample Value 3",
          "displayValue": "Sample Value 3"
        },
        {
          "columnId": 642523719853956,
          "value": "Sample Value 4",
          "displayValue": "Sample Value 4"
        }
      ]
    }
  ]
}

​
Notes

Smartsheet API uses custom proxy integration through Paragon. Sheet IDs are numeric identifiers found in sheet URLs. Each sheet contains columns and rows with cells that store data. Columns are identified by ID and have types like TEXT_NUMBER, DATE, PICKLIST. Rows contain cells that reference column IDs for data organization. The API supports both reading sheet lists and detailed sheet data including cell values and formatting information.