The Smartsheet connector lets your AI agent act in each user's Smartsheet account. Each user signs in to Smartsheet once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 27 tools.
- Tools
- 27
- What they doRead · write · destructive
- 18 · 8 · 118 read8 write1 destructive
- Users sign in with
- OAuth
- OAuth app
- Your own Smartsheet app
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Smartsheet connection
In AgentKit > Connections, create a Smartsheet connection and copy its redirect URI. The name you give it is the
connection_nameyour code passes. See Configure connections.Register an OAuth app
Smartsheet connections use your own OAuth app. Register one with Smartsheet and add the redirect URI you copied.
Then enter the app's Client ID and Client Secret on the Smartsheet connection.
Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'smartsheet'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Smartsheet:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'smartsheet_current_user_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "smartsheet"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Smartsheet:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="smartsheet_current_user_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user signs in once. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolsmartsheet_attachments_listList all attachments on a sheet, including those on its rows and in its discussions.Read-onlyList Attachments
List all attachments on a sheet, including those on its rows and in its discussions. Returns each attachment's id, name, attachmentType (FILE, LINK, GOOGLE_DRIVE, and others), mimeType, sizeInKb, parentType, parentId, and createdAt. File contents are not returned. Use smartsheet_attachments_list to see what files and links a sheet holds.
Inputs
sheet_idstringrequired- ID of the sheet, as a numeric string. Get it from smartsheet_sheets_list, smartsheet_items_search, or a sheet URL's properties in Smartsheet. Example: "4583173393803140".
include_allboolean- Set to true to return every item in one response instead of paging. Defaults to false. Example: true.
pageinteger- Page number to return, starting at 1. Defaults to 1. A page past the end returns the last page. Ignored when include_all is true. Example: 2.
page_sizeinteger- Maximum number of items per page. Defaults to 100. Ignored when include_all is true. Example: 50.
smartsheet_columns_listList the columns of a sheet.Read-onlyList Columns
List the columns of a sheet. Returns each column's id, index, title, type, primary flag, and options (for picklist columns). Use smartsheet_columns_list to get the column ids that smartsheet_rows_add and smartsheet_rows_update need. Use smartsheet_sheet_get to read columns together with row data.
Inputs
sheet_idstringrequired- ID of the sheet, as a numeric string. Get it from smartsheet_sheets_list, smartsheet_items_search, or a sheet URL's properties in Smartsheet. Example: "4583173393803140".
include_allboolean- Set to true to return every item in one response instead of paging. Defaults to false. Example: true.
levelinteger- Format for multi-contact and multi-picklist cells. 0 (default) returns them as plain text; 1 returns multi-contact cells as objects; 2 also returns multi-picklist cells as objects. Combine with include=objectValue to get contact email addresses. Example: 2.one of
012 pageinteger- Page number to return, starting at 1. Defaults to 1. A page past the end returns the last page. Ignored when include_all is true. Example: 2.
page_sizeinteger- Maximum number of items per page. Defaults to 100. Ignored when include_all is true. Example: 50.
smartsheet_current_user_getGet the profile of the Smartsheet user who authorized this connection.Read-onlyGet Current User
Get the profile of the Smartsheet user who authorized this connection. Returns the user's id, email, first and last name, locale, time zone, account details, and admin flags, plus their groups when requested. Use it to learn who the connection acts as, for example before sharing an asset or filtering by owner.
Inputs
includestring- Set to groups to also return the groups (id, name, description) the user belongs to. Leave empty for the profile only. Example: "groups".one of
groups
smartsheet_discussion_getGet one discussion on a sheet with all its comments.Read-onlyGet Discussion
Get one discussion on a sheet with all its comments. Returns the discussion's id, title, parentId, parentType, and comments (id, text, createdBy, createdAt). Use smartsheet_discussion_get to read a full thread. Use smartsheet_comment_create to reply to it.
Inputs
discussion_idstringrequired- ID of the discussion, as returned in the id field by smartsheet_discussions_list. Example: "3962273862576004".
sheet_idstringrequired- ID of the sheet, as a numeric string. Get it from smartsheet_sheets_list, smartsheet_items_search, or a sheet URL's properties in Smartsheet. Example: "4583173393803140".
smartsheet_discussions_listList the discussions (comment threads) on a sheet, including those on its rows.Read-onlyList Discussions
List the discussions (comment threads) on a sheet, including those on its rows. Returns each discussion's id, title, parentId, parentType (SHEET or ROW), commentCount, and lastCommentedAt, plus the comments when requested. Use smartsheet_discussions_list to browse conversations on a sheet. Use smartsheet_discussion_get to read one thread in full.
Inputs
sheet_idstringrequired- ID of the sheet, as a numeric string. Get it from smartsheet_sheets_list, smartsheet_items_search, or a sheet URL's properties in Smartsheet. Example: "4583173393803140".
includestring- Comma-separated extra data: comments (every comment in each thread) and attachments (comment attachments; only works together with comments). Example: "comments".
include_allboolean- Set to true to return every item in one response instead of paging. Defaults to false. Example: true.
pageinteger- Page number to return, starting at 1. Defaults to 1. A page past the end returns the last page. Ignored when include_all is true. Example: 2.
page_sizeinteger- Maximum number of items per page. Defaults to 100. Ignored when include_all is true. Example: 50.
smartsheet_folder_children_listList the sheets, reports, dashboards, sub-folders, and templates directly inside a folder.Read-onlyList Folder Contents
List the sheets, reports, dashboards, sub-folders, and templates directly inside a folder. Returns each child's id, name, resourceType, and permalink, plus lastKey when more pages exist. Items inside sub-folders are not included. Use smartsheet_folder_children_list to browse a folder. Use smartsheet_workspace_children_list for the top level of a workspace.
Inputs
folder_idstringrequired- ID of the folder, as a numeric string. Get it from smartsheet_workspace_children_list or smartsheet_folder_children_list. Example: "5709073300645764".
children_resource_typesstring- Comma-separated child types to return. Allowed: sheets, reports, sights (dashboards), folders, templates. If you include templates, also include sheets. Leave empty for all types. Example: "sheets,folders".
includestring- Comma-separated extra data for each child: source (what it was created from) and ownerInfo (the owner's user). Example: "ownerInfo".
last_keystring- Paging token. Pass the lastKey value from the previous response to get the next page; leave empty for the first page. Example: "MTIzNDU2Nzg5".
max_itemsinteger- Maximum number of items to return. The minimum and default is 100, the maximum is 1000. Example: 200.
smartsheet_folder_getGet the details of one folder, without its contents.Read-onlyGet Folder
Get the details of one folder, without its contents. Returns the folder's id, name, permalink, createdAt, and modifiedAt. Use smartsheet_folder_get for folder details. Use smartsheet_folder_children_list for the sheets, reports, and sub-folders inside it.
Inputs
folder_idstringrequired- ID of the folder, as a numeric string. Get it from smartsheet_workspace_children_list or smartsheet_folder_children_list. Example: "5709073300645764".
includestring- Set to source to add the object the folder was created from, if any. Example: "source".one of
source
smartsheet_items_searchSearch all sheets, reports, dashboards, workspaces, folders, and templates the user can access for a text.Read-onlySearch Everything
Search all sheets, reports, dashboards, workspaces, folders, and templates the user can access for a text. Returns matching results with objectType, objectId, parentObjectId, text, contextData, and the total count. Use smartsheet_items_search to find content across the account. Use smartsheet_sheet_search to search inside one sheet and smartsheet_sheets_list to browse sheets by name.
Inputs
querystringrequired- Text to search for. Wrap it in double quotes to match the exact phrase. Example: "launch plan".
includestring- Set to favoriteFlag to mark which results the user has added to Favorites. Example: "favoriteFlag".one of
favoriteFlag modified_sincestring- Only return items modified on or after this time, as an ISO 8601 date-time in UTC. Example: "2026-01-01T00:00:00Z".
scopesstring- Comma-separated places to search. Allowed: attachments, cellData, comments, folderNames, reportNames, sheetNames, sightNames, summaryFields, templateNames, workspaceNames. Leave empty to search everywhere. Example: "sheetNames,cellData".
smartsheet_report_getGet one report with its columns and rows gathered from its source sheets.Read-onlyGet Report
Get one report with its columns and rows gathered from its source sheets. Returns the report's id, name, permalink, columns (virtualId, title, type), rows with cells and the sheetId each row comes from, and totalRowCount. Use smartsheet_report_get to read report data. Use smartsheet_reports_list to find the report id first.
Inputs
report_idstringrequired- ID of the report, as a numeric string. Get it from smartsheet_reports_list. Example: "4583173393803140".
excludestring- Comma-separated data to leave out. Allowed: linkInFromCellDetails, linksOutToCellsDetails. Example: "linkInFromCellDetails".
includestring- Comma-separated extra data to return. Allowed: attachments, discussions, proofs, format, objectValue, scope, source, sourceSheets. Example: "sourceSheets".
levelinteger- Format for multi-contact and multi-picklist cells. 0 (default) returns them as plain text; 1 returns multi-contact cells as objects; 2 also returns multi-picklist cells as objects. Combine with include=objectValue to get contact email addresses. Example: 2.one of
012 pageinteger- Page of rows to return, starting at 1. Defaults to 1. Example: 2.
page_sizeinteger- Maximum number of rows per page. Defaults to 100; the maximum is 10,000. Example: 500.
smartsheet_reports_listList the reports the user can access.Read-onlyList Reports
List the reports the user can access. Returns each report's id, name, accessLevel, permalink, createdAt, and modifiedAt. Use smartsheet_reports_list to find a report id. Use smartsheet_report_get to read a report's rows.
Inputs
modified_sincestring- Only return reports modified on or after this time, as an ISO 8601 date-time in UTC. Example: "2026-01-01T00:00:00Z".
smartsheet_row_getGet one row of a sheet by its id.Read-onlyGet Row
Get one row of a sheet by its id. Returns the row's id, rowNumber, parentId, createdAt, modifiedAt, and cells (columnId, value, displayValue), plus columns, discussions, or attachments when requested. Use smartsheet_row_get when you already have a row id. Use smartsheet_sheet_get to read many rows and smartsheet_sheet_search to find rows by text.
Inputs
row_idstringrequired- ID of the row, as a numeric string. Get it from the rows array returned by smartsheet_sheet_get or smartsheet_sheet_search. Example: "2361756178769796".
sheet_idstringrequired- ID of the sheet, as a numeric string. Get it from smartsheet_sheets_list, smartsheet_items_search, or a sheet URL's properties in Smartsheet. Example: "4583173393803140".
excludestring- Comma-separated data to leave out. Allowed: filteredOutRows, linkInFromCellDetails, linksOutToCellsDetails, nonexistentCells (empty cells). Example: "nonexistentCells".
includestring- Comma-separated extra data to return with the row. Allowed: attachments, columns, columnType, discussions, filters, format, objectValue, proofs, rowPermalink, writerInfo. Use columns to get the column titles that match each cell's columnId. Example: "columns,discussions".
levelinteger- Format for multi-contact and multi-picklist cells. 0 (default) returns them as plain text; 1 returns multi-contact cells as objects; 2 also returns multi-picklist cells as objects. Combine with include=objectValue to get contact email addresses. Example: 2.one of
012
smartsheet_sheet_getGet one sheet with its columns and rows, optionally narrowed to some rows or columns.Read-onlyGet Sheet
Get one sheet with its columns and rows, optionally narrowed to some rows or columns. Returns the sheet's id, name, permalink, columns (id, title, type), and rows with their cells (columnId, value, displayValue), plus totalRowCount. Use smartsheet_sheet_get to read sheet data. Use smartsheet_row_get for a single row, smartsheet_columns_list for column ids only, and smartsheet_sheet_search to find rows by text.
Inputs
sheet_idstringrequired- ID of the sheet, as a numeric string. Get it from smartsheet_sheets_list, smartsheet_items_search, or a sheet URL's properties in Smartsheet. Example: "4583173393803140".
column_idsstring- Comma-separated column ids. When set, only these columns and their cells are returned. Get column ids from smartsheet_columns_list. Example: "7960873114331012,642523719853956".
excludestring- Comma-separated data to leave out. Allowed: filteredOutRows, linkInFromCellDetails, linksOutToCellsDetails, nonexistentCells (empty cells). Example: "nonexistentCells".
filter_idstring- ID of a saved sheet filter to apply. Rows the filter hides are marked filteredOut: true. Example: "6362915432441732".
includestring- Comma-separated extra data to return. Allowed: attachments, columnType, crossSheetReferences, discussions, filters, filterDefinitions, format, ganttConfig, objectValue, ownerInfo, proofs, rowPermalink, source, writerInfo. Example: "rowPermalink,writerInfo".
levelinteger- Format for multi-contact and multi-picklist cells. 0 (default) returns them as plain text; 1 returns multi-contact cells as objects; 2 also returns multi-picklist cells as objects. Combine with include=objectValue to get contact email addresses. Example: 2.one of
012 pageinteger- Page of rows to return, starting at 1. Defaults to 1. Example: 2.
page_sizeinteger- Maximum number of rows per page. Defaults to 100. Example: 500.
row_idsstring- Comma-separated row ids. When set, only these rows are returned. Example: "2361756178769796,6865355806140292".
row_numbersstring- Comma-separated row numbers (the 1-based position shown in Smartsheet). Row numbers that do not exist are ignored. Example: "1,2,10".
rows_modified_sincestring- Only return rows modified on or after this time, as an ISO 8601 date-time in UTC. Example: "2026-01-01T00:00:00Z".
smartsheet_sheet_searchSearch the rows of one sheet for a text.Read-onlySearch Sheet
Search the rows of one sheet for a text. Returns matching results with objectType, objectId (the row id), parentObjectId (the sheet id), text, and contextData. Use smartsheet_sheet_search to find rows in a known sheet. Use smartsheet_items_search to search across all sheets, then smartsheet_row_get to read a matching row.
Inputs
querystringrequired- Text to search for. Wrap it in double quotes to match the exact phrase. Example: "Acme Corp".
sheet_idstringrequired- ID of the sheet, as a numeric string. Get it from smartsheet_sheets_list, smartsheet_items_search, or a sheet URL's properties in Smartsheet. Example: "4583173393803140".
smartsheet_sheets_listList every sheet the user can access, across all workspaces and folders.Read-onlyList Sheets
List every sheet the user can access, across all workspaces and folders. Returns sheet id, name, accessLevel, permalink, createdAt, and modifiedAt for each sheet, with page and total counts. Use smartsheet_sheets_list to browse or find a sheet id by name. Use smartsheet_items_search for a text search inside sheets, and smartsheet_workspace_children_list to stay inside one workspace.
Inputs
includestring- Extra data to add to each sheet: sheetVersion (current version number; do not combine with paging) or source (the sheet or template it was created from). Example: "source".one of
sheetVersionsource include_allboolean- Set to true to return every item in one response instead of paging. Defaults to false. Example: true.
modified_sincestring- Only return sheets modified on or after this time, as an ISO 8601 date-time in UTC. Example: "2026-01-01T00:00:00Z".
pageinteger- Page number to return, starting at 1. Defaults to 1. A page past the end returns the last page. Ignored when include_all is true. Example: 2.
page_sizeinteger- Maximum number of items per page. Defaults to 100. Ignored when include_all is true. Example: 50.
smartsheet_workspace_children_listList the sheets, reports, dashboards, folders, and templates directly inside a workspace.Read-onlyList Workspace Contents
List the sheets, reports, dashboards, folders, and templates directly inside a workspace. Returns each child's id, name, resourceType, and permalink, plus lastKey when more pages exist. Items inside sub-folders are not included. Use smartsheet_workspace_children_list to browse a workspace. Use smartsheet_folder_children_list to go into a folder it returns.
Inputs
workspace_idstringrequired- ID of the workspace, as a numeric string. Get it from smartsheet_workspaces_list. Example: "7116448184199044".
children_resource_typesstring- Comma-separated child types to return. Allowed: sheets, reports, sights (dashboards), folders, templates. If you include templates, also include sheets. Leave empty for all types. Example: "sheets,folders".
includestring- Comma-separated extra data for each child: source (what it was created from) and ownerInfo (the owner's user). Example: "ownerInfo".
last_keystring- Paging token. Pass the lastKey value from the previous response to get the next page; leave empty for the first page. Example: "MTIzNDU2Nzg5".
max_itemsinteger- Maximum number of items to return. The minimum and default is 100, the maximum is 1000. Example: 200.
smartsheet_workspace_getGet the details of one workspace, without its contents.Read-onlyGet Workspace
Get the details of one workspace, without its contents. Returns the workspace's id, name, accessLevel, permalink, createdAt, and modifiedAt. Use smartsheet_workspace_get for workspace details. Use smartsheet_workspace_children_list for the sheets, reports, and folders inside it.
Inputs
workspace_idstringrequired- ID of the workspace, as a numeric string. Get it from smartsheet_workspaces_list. Example: "7116448184199044".
includestring- Set to source to add the object the workspace was created from, if any. Example: "source".one of
source
smartsheet_workspaces_listList the workspaces the user can access.Read-onlyList Workspaces
List the workspaces the user can access. Returns workspace id, name, accessLevel, and permalink for each workspace, plus lastKey when more pages exist. Use smartsheet_workspaces_list to find a workspace id. Use smartsheet_workspace_children_list to see what a workspace contains.
Inputs
last_keystring- Paging token. Pass the lastKey value from the previous response to get the next page; leave empty for the first page. Example: "MTIzNDU2Nzg5".
max_itemsinteger- Maximum number of workspaces to return. The minimum and default is 100, the maximum is 1000. Example: 200.
smartsheet_columns_addAdd one or more columns to an existing sheet.WriteAdd Columns
Add one or more columns to an existing sheet. Returns the created columns with their new ids, index, title, and type. Use smartsheet_columns_add to extend a sheet's structure. Use smartsheet_sheet_create to make a new sheet with columns.
Inputs
columnsarrayrequired- Columns to add. Each needs a title, a type (TEXT_NUMBER, DATE, DATETIME, CONTACT_LIST, MULTI_CONTACT_LIST, CHECKBOX, PICKLIST, MULTI_PICKLIST, DURATION, PREDECESSOR, or ABSTRACT_DATETIME), and an index, the zero-based position to insert at. All columns in one call must use the same index; they are inserted there in the order given. PICKLIST columns take their choices in options. Example: [{"title": "Owner", "type": "CONTACT_LIST", "index": 2}, {"title": "Priority", "type": "PICKLIST", "options": ["High", "Medium", "Low"], "index": 2}].
sheet_idstringrequired- ID of the sheet, as a numeric string. Get it from smartsheet_sheets_list, smartsheet_items_search, or a sheet URL's properties in Smartsheet. Example: "4583173393803140".
smartsheet_comment_createAdd a comment to an existing discussion on a sheet or row.WriteAdd Comment
Add a comment to an existing discussion on a sheet or row. Returns the new comment's id, text, createdBy, and createdAt. Use smartsheet_comment_create to reply in a thread. Use smartsheet_discussion_create or smartsheet_row_discussion_create to start a new thread. Get the discussion id from smartsheet_discussions_list first.
Inputs
discussion_idstringrequired- ID of the discussion, as returned in the id field by smartsheet_discussions_list. Example: "3962273862576004".
sheet_idstringrequired- ID of the sheet, as a numeric string. Get it from smartsheet_sheets_list, smartsheet_items_search, or a sheet URL's properties in Smartsheet. Example: "4583173393803140".
textstringrequired- Text of the comment. Example: "Done, moved to Friday.".
smartsheet_discussion_createStart a new discussion on a sheet as a whole, with a first comment.WriteCreate Sheet Discussion
Start a new discussion on a sheet as a whole, with a first comment. Returns the new discussion's id, title, and its first comment. Use smartsheet_discussion_create for a sheet-level thread. Use smartsheet_row_discussion_create to comment on a specific row, and smartsheet_comment_create to reply in an existing thread.
Inputs
sheet_idstringrequired- ID of the sheet, as a numeric string. Get it from smartsheet_sheets_list, smartsheet_items_search, or a sheet URL's properties in Smartsheet. Example: "4583173393803140".
textstringrequired- Text of the first comment in the discussion. Example: "Budget numbers are updated for Q3.".
smartsheet_row_discussion_createStart a new discussion on one row of a sheet, with a first comment.WriteCreate Row Discussion
Start a new discussion on one row of a sheet, with a first comment. Returns the new discussion's id, title, and its first comment. Use smartsheet_row_discussion_create to comment on a specific row. Use smartsheet_discussion_create for a sheet-level thread and smartsheet_comment_create to reply in an existing thread.
Inputs
row_idstringrequired- ID of the row, as a numeric string. Get it from the rows array returned by smartsheet_sheet_get or smartsheet_sheet_search. Example: "2361756178769796".
sheet_idstringrequired- ID of the sheet, as a numeric string. Get it from smartsheet_sheets_list, smartsheet_items_search, or a sheet URL's properties in Smartsheet. Example: "4583173393803140".
textstringrequired- Text of the first comment in the discussion. Example: "Can we move this due date to Friday?".
smartsheet_rows_addAdd one or more rows to a sheet, with cell values and an optional position.WriteAdd Rows
Add one or more rows to a sheet, with cell values and an optional position. Returns the created rows with their new ids, rowNumber, and cells, plus a result code. Use smartsheet_rows_add for new rows. Use smartsheet_rows_update to change existing rows. Call smartsheet_columns_list first to get the column ids the cells refer to.
Inputs
rowsarrayrequired- Rows to add. Each row object takes a cells array; each cell names a column by its columnId (from smartsheet_columns_list) and gives a value, for example {"columnId": 7960873114331012, "value": "In progress"}. Use strict: false on a cell to let Smartsheet coerce the value, or formula instead of value to set a formula such as "=SUM([Cost]1:[Cost]5)". To choose where a row goes, add one location setting: toTop: true, toBottom: true (the default is the bottom), parentId to make it the first child of another row, or siblingId to place it right below another row. All rows in one call must use the same location setting. Example: [{"toBottom": true, "cells": [{"columnId": 7960873114331012, "value": "Write launch post"}, {"columnId": 642523719853956, "value": "Not started"}]}].
sheet_idstringrequired- ID of the sheet, as a numeric string. Get it from smartsheet_sheets_list, smartsheet_items_search, or a sheet URL's properties in Smartsheet. Example: "4583173393803140".
allow_partial_successboolean- Set to true to add the valid rows even when some rows fail; the response lists the failed ones. Defaults to false (all or nothing). Example: true.
override_validationboolean- Set to true to accept cell values outside a column's validation rules (the cell must also set strict: false). Defaults to false. Example: true.
smartsheet_rows_updateUpdate cell values, position, or expanded state of one or more existing rows in a sheet.WriteUpdate Rows
Update cell values, position, or expanded state of one or more existing rows in a sheet. Returns the updated rows with their cells, plus a result code. Use smartsheet_rows_update to change existing rows. Use smartsheet_rows_add for new rows and smartsheet_rows_delete to remove rows. Get row ids from smartsheet_sheet_get and column ids from smartsheet_columns_list first.
- Idempotent
Inputs
rowsarrayrequired- Rows to update. Each row object needs its id; only the cells you list change. Each row object takes a cells array; each cell names a column by its columnId (from smartsheet_columns_list) and gives a value, for example {"columnId": 7960873114331012, "value": "In progress"}. Use strict: false on a cell to let Smartsheet coerce the value, or formula instead of value to set a formula such as "=SUM([Cost]1:[Cost]5)". To move a row, add one location setting (toTop, toBottom, parentId, siblingId) or indent/outdent: 1. To clear a cell, set its value to an empty string. Example: [{"id": 2361756178769796, "cells": [{"columnId": 642523719853956, "value": "Done"}]}].
sheet_idstringrequired- ID of the sheet, as a numeric string. Get it from smartsheet_sheets_list, smartsheet_items_search, or a sheet URL's properties in Smartsheet. Example: "4583173393803140".
allow_partial_successboolean- Set to true to apply the valid updates even when some rows fail; the response lists the failed ones. Defaults to false (all or nothing). Example: true.
override_validationboolean- Set to true to accept cell values outside a column's validation rules (the cell must also set strict: false). Defaults to false. Example: true.
smartsheet_sheet_createCreate a new sheet with the given columns in the user's Sheets folder.WriteCreate Sheet
Create a new sheet with the given columns in the user's Sheets folder. Returns the new sheet's id, name, permalink, accessLevel, and its columns with their ids. Use smartsheet_sheet_create to start a new sheet. Use smartsheet_columns_add to add columns to an existing sheet and smartsheet_rows_add to fill it.
Inputs
columnsarrayrequired- Columns of the new sheet, in order. Each column needs a title and a type: TEXT_NUMBER, DATE, DATETIME, CONTACT_LIST, MULTI_CONTACT_LIST, CHECKBOX, PICKLIST, MULTI_PICKLIST, DURATION, PREDECESSOR, or ABSTRACT_DATETIME. Exactly one column must be the primary column (primary: true, type TEXT_NUMBER). PICKLIST columns take their choices in options; CHECKBOX columns can set a symbol such as FLAG or STAR. Example: [{"title": "Task", "type": "TEXT_NUMBER", "primary": true}, {"title": "Status", "type": "PICKLIST", "options": ["Not started", "In progress", "Done"]}, {"title": "Due", "type": "DATE"}].
namestringrequired- Name of the new sheet. Example: "Q3 Launch Plan".
smartsheet_rows_deletePermanently delete one or more rows from a sheet.DestructiveDelete Rows
Permanently delete one or more rows from a sheet. Child rows of a deleted row are deleted too. Returns the ids of the deleted rows and a result code. Use smartsheet_rows_delete only to remove rows. Use smartsheet_rows_update to clear or change cell values instead.
- Idempotent
Inputs
idsstringrequired- Comma-separated ids of the rows to delete. Get them from smartsheet_sheet_get or smartsheet_sheet_search. Example: "2361756178769796,6865355806140292".
sheet_idstringrequired- ID of the sheet, as a numeric string. Get it from smartsheet_sheets_list, smartsheet_items_search, or a sheet URL's properties in Smartsheet. Example: "4583173393803140".
ignore_rows_not_foundboolean- Set to true to delete the rows that exist and skip ids that are not found. Defaults to false, which deletes nothing and returns an error when any id is not found. Example: true.
No tools match.