Lodol Docs

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

ParameterTypeRequiredDescription
sheet_idnumberYesSmartsheet sheet ID.
titlestringYesColumn title.
typestringYesColumn type (TEXT_NUMBER, DATE, etc.).
primarybooleanNoWhether the column is primary.

Response

{
  "message": "SUCCESS",
  "result": [
    {
      "id": 444555666,
      "title": "Status"
    }
  ],
  "resultCode": 0
}

Add rows

Add rows to a Smartsheet sheet.

Parameters

ParameterTypeRequiredDescription
sheet_idnumberYesSmartsheet sheet ID.
rowsarrayYesRows to add with cell values.

Response

{
  "message": "SUCCESS",
  "result": [
    {
      "cells": [],
      "id": 111222333
    }
  ],
  "resultCode": 0
}

Create sheet

Create a new Smartsheet sheet with columns.

Parameters

ParameterTypeRequiredDescription
namestringYesSheet name.
columnsarrayYesList of column definitions with title and type.

Response

{
  "message": "SUCCESS",
  "result": {
    "id": 987654321,
    "name": "New Sheet"
  },
  "resultCode": 0
}

Get sheet details

Retrieve full details of a specific Smartsheet sheet.

Parameters

ParameterTypeRequiredDescription
sheet_idnumberYesSmartsheet sheet ID.

Response

{
  "columns": [],
  "id": 123456789,
  "name": "Project Plan",
  "rows": []
}

List sheets

Retrieve all sheets accessible to the connected Smartsheet account.

Response

[
  {
    "accessLevel": "ADMIN",
    "id": 123456789,
    "name": "Project Plan"
  }
]

Share sheet

Share a Smartsheet sheet with a collaborator.

Parameters

ParameterTypeRequiredDescription
sheet_idnumberYesSmartsheet sheet ID.
emailstringYesEmail address to share with.
access_levelstringYesAccess level (VIEWER, EDITOR, ADMIN).

Response

{
  "message": "SUCCESS",
  "result": [
    {
      "accessLevel": "EDITOR",
      "email": "user@example.com",
      "id": "share_123"
    }
  ],
  "resultCode": 0
}

Update row cells

Update cell values in a specific row.

Parameters

ParameterTypeRequiredDescription
sheet_idnumberYesSmartsheet sheet ID.
row_idnumberYesRow ID to update.
cellsarrayYesList of cell updates.

Response

{
  "message": "SUCCESS",
  "result": [
    {
      "cells": [],
      "id": 111222333
    }
  ],
  "resultCode": 0
}

On this page