Introduction
Last updated

Introduction

The Smartsheet API enables you to programatically access and manage your organziation's Smartsheet resources. Here are some of the things you can do:

  • Read and update sheets
  • Manage folders and workspaces
  • Administer Smartsheet plans and user accounts

The API Reference includes object schemas, method specifications, and code snippets for Sheets, Cells, Folders and more.

IMPORTANT:

  • The Smartsheet API is restricted to users on Business and Enterprise plans
  • The Developer Agreement governs the use of the Smartsheet API and Smartsheet software development kits (SDKs)

Let's start with the essentials.

Base URL

Smartsheet: https://api.smartsheet.com/2.0

Important: Smartsheet Gov and Smartsheet Regions Europe use the respective base URLs:

  • Smartsheet Gov: https://api.smartsheetgov.com/2.0
  • Smartsheet Regions Europe: https://api.smartsheet.eu/2.0

Authentication

The API authenticates using access tokens (API keys). You can generate access tokens in the Smartsheet UI.

Important: Smartsheet Gov and Smartsheet Regions Europe use separate tokens from Smartsheet.com.

Each API request requires passing in an access token as the Bearer value in your authorization header. For example,

Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789

Request

For example, you can list your sheets by executing the following GET /sheets method (swap in your access token).

curl -X GET -H "Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789" \
"https://api.smartsheet.com/2.0/sheets"

Response

The JSON response should look something like this (after formatting):

{
"pageNumber": 1,
"pageSize": 100,
"totalPages": 1,
"totalCount": 2,
"data": [
    {
    "id": 6141831453927300,
    "name": "My first sheet",
    "accessLevel": "ADMIN",
    "permalink": "https://app.smartsheet.com/b/home?lx=8enlO7GkdYSz-cHHVus33A",
    "createdAt": "2023-09-25T17:38:02Z",
    "modifiedAt": "2023-09-25T17:38:09Z"
    },
    {
    "id": 6141831453927300,
    "name": "Sheet shared to me",
    "accessLevel": "VIEWER",
    "permalink": "https://app.smartsheet.com/b/home?lx=8enlO7GkdYSz-cHHVus33A",
    "createdAt": "2017-06-27T21:17:15Z",
    "modifiedAt": "2023-04-19T17:16:05Z"
    }
]
}

Congratulations on executing your first Smartsheet API request!

What's next?

 
Next page