Getting Started

Generate an API access token

You can generate access tokens in the Smartsheet UI.

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

1. Go to the Smartsheet UI.
2. Click the Account button in the lower-left corner of the Smartsheet screen, and then click Personal Settings.
3. Click the API Access tab.
4. Click the Generate new access token button to obtain an access token.

Important: Store your access token in a secure location. See Access Token Best Practices.

Make your first request

Let's start with someting useful and easy. You can list your sheets by executing the following GET /sheets method (swap in your access token) at your command prompt (terminal).

Request:

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!