Smartsheet
API actions for the Smartsheet integration.
Smartsheet
Manage Smartsheet sheets, columns, rows, and sharing with an API token.
Add column
Add a column to an existing Smartsheet sheet.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
sheet_id | string | Yes | The ID number of the sheet, as returned by 'List sheets'. |
title | string | Yes | The heading shown at the top of the new column. |
type | string | Yes | What kind of values this column holds. |
Response
{
"message": "SUCCESS",
"result": [
{
"id": 444555666,
"title": "Status"
}
],
"resultCode": 0
}Create sheet
Create a new Smartsheet sheet with columns.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | A name for the new sheet. |
columns | array | Yes | The columns for the new sheet. Each column needs a title and a type. Exactly one column must be marked as the primary column (the main column shown first). |
Response
{
"message": "SUCCESS",
"result": {
"id": 987654321,
"name": "New Sheet"
},
"resultCode": 0
}Get sheet details
Get the details of a Smartsheet sheet, including its columns and rows.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
sheet_id | string | Yes | The ID number of the sheet, as returned by 'List sheets'. |
Response
{
"columns": [],
"id": 123456789,
"name": "Project Plan",
"rows": []
}List sheets
List all sheets in your Smartsheet account.
Response
[
{
"accessLevel": "ADMIN",
"id": 123456789,
"name": "Project Plan"
}
]Share sheet
Share a Smartsheet sheet with a collaborator.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
sheet_id | string | Yes | The ID number of the sheet, as returned by 'List sheets'. |
email | string | Yes | The email address of the person to share the sheet with. |
access_level | string | Yes | How much access the person gets. |
Response
{
"message": "SUCCESS",
"result": [
{
"accessLevel": "EDITOR",
"email": "user@example.com",
"id": "share_123"
}
],
"resultCode": 0
}