> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/smartsheet.md).

# Smartsheet

Smartsheet is a work management platform built on spreadsheets. Connect to create and search sheets, add rows and columns, and upload attachments from your AI workflows.

## Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector  | Authentication |
| ---------- | -------------- |
| Smartsheet | API Key        |

### Smartsheet

Connect to Smartsheet to access your sheets, rows, columns, and workspaces. Supports reading data, managing sheets, and updating content.

#### Set up in Smartsheet

1. Sign in to Smartsheet and open Account (your profile icon, bottom-left) then Personal Settings.
2. Go to the API Access tab and click Generate new access token.
3. Copy the generated API access token immediately and store it securely; it grants access as your Smartsheet user.

#### Set up in StackAI

1. Open **Settings → Connections**, add a connection, and select **Smartsheet**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                                                                                |
| ------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes      | Your Smartsheet API access token. You can generate one in your Smartsheet account settings under 'Personal Settings' > 'API Access'. [Provider instructions](https://help.smartsheet.com/articles/2482389-generate-API-key). |

**Provider documentation:** [Setup reference](https://developers.smartsheet.com/api/smartsheet/introduction/authentication).

### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Detailed setup guides

* [Connect Smartsheet](https://docs.stackai.com/integrations/catalog/smartsheet/connect-smartsheet.md)

## Use an action

1. Add the required **Smartsheet** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

## Actions

### List Sheets

Gets a list of all sheets that the user has access to. The list contains an abbreviated Sheet object for each sheet.

#### Inputs

| Field            | Type    | Required | Description                                                                                                                                                                                                                                                                                                                      |
| ---------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Include          | string  | No       | A comma-separated list of optional elements to include in the response: \* **sheetVersion** - current version number of each sheet, should not be combined with pagination \* **source** - the Source object for any sheet that was created from another sheet, if any.                                                          |
| Include All      | boolean | No       | If true, include all results, that is, do not paginate. Mutually exclusive with page and pageSize (they are ignored if includeAll=true is specified). Default: false.                                                                                                                                                            |
| Modified Since   | string  | No       | When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified. If you need to keep track of frequent changes, it may be more useful to use Get Sheet Version.                                                                                          |
| Numeric Dates    | boolean | No       | You can optionally choose to receive and send dates/times in numeric format, as milliseconds since the UNIX epoch (midnight on January 1, 1970 in UTC time), using the query string parameter numericDates with a value of true. This query parameter works for any API request. Default: false.                                 |
| Page             | integer | No       | Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned. Minimum: 1. Default: 1.                                                                                                                                               |
| Page Size        | integer | No       | The maximum number of items to return per page. Unless otherwise stated for a specific endpoint, defaults to 100. If only page is specified, defaults to a page size of 100. For reports, the default is 100 rows. If you need larger sets of data from your report, returns a maximum of 10,000 rows per request. Default: 100. |
| Access API Level | integer | No       | Allows COMMENTER access for inputs and return values. For backwards-compatibility, VIEWER is the default. For example, to see whether a user has COMMENTER access for a sheet, use accessApiLevel=1. Default: 0.                                                                                                                 |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Create Folder

Create a new folder, either at the top level of a workspace or inside an existing folder. Optionally specify include, exclude, or skipRemap parameters for copying behavior.

#### Inputs

| Field         | Type             | Required | Description                                                                                                                                                                             |
| ------------- | ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Workspace     | select (integer) | No       | Workspace where the folder should be created at the top level. Provide either a workspace or a parent folder, not both. Options load from the selected connection.                      |
| Parent Folder | select (integer) | No       | Folder to create the new folder inside. Pick a workspace above to list its folders. Provide either a workspace or a parent folder, not both. Options load from the selected connection. |
| Folder Name   | string           | Yes      | Name for the new folder.                                                                                                                                                                |
| Include       | string           | No       | A comma-separated list of elements to copy when creating the folder. Options: attachments, cellLinks, data, discussions, filters, forms, ruleRecipients, rules, shares.                 |
| Exclude       | string           | No       | When specified with a value of 'sheetHyperlinks', excludes this category from the response.                                                                                             |
| Skip Remap    | string           | No       | A comma-separated list of references to NOT re-map for the newly created folder.                                                                                                        |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Search Everything

Searches all sheets that the user can access, for the specified text. If you have not used the public API in a while, we will need to provision your data. This could take up to 24 hours so please check back later!

#### Inputs

| Field          | Type          | Required | Description                                                                                                                                                                                                                                                                                                                                                        |
| -------------- | ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Query          | string        | Yes      | Text with which to perform the search. Enclose in double-quotes for an exact search.                                                                                                                                                                                                                                                                               |
| Modified Since | string        | No       | When specified with a date and time value, response only includes the objects that are modified on or after the date and time specified. If you need to keep track of frequent changes, it may be more useful to use Get Sheet Version.                                                                                                                            |
| Include        | string        | No       | When specified with a value of **favoriteFlag**, response indicates which returned items are favorites. favorite -- dashboards, folders, reports, sheets, templates, and workspaces will have the property favorite: true parentObjectFavorite -- attachments, discussions, summary fields, and rows will have the property parentObjectFavorite: true. Default: . |
| Scopes         | string\_array | No       | Optional. Narrow the search to specific asset types. Choose from: attachments, cellData, comments, folderNames, reportNames, sheetNames, sightNames, summaryFields, templateNames, workspaceNames. Leave empty to search everything.                                                                                                                               |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Search Sheet

Gets a list of the user's search results in a sheet based on query. The list contains an abbreviated row object for each search result in a sheet. If you have not used the public API in a while, we will need to provision your data. This could take up to 24 hours so please check back later! *Note* Newly created or recently updated data may not be immediately discoverable via search.

#### Inputs

| Field              | Type             | Required | Description                                                                                                                                                                                               |
| ------------------ | ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Query              | string           | Yes      | Text with which to perform the search. Enclose in double-quotes for an exact search.                                                                                                                      |
| Workspace (filter) | select (integer) | No       | Optional. Narrow the Sheet list to one workspace. Leave empty to list every sheet. Options load from the selected connection.                                                                             |
| Folder (filter)    | select (integer) | No       | Optional. Narrow the Sheet list further to one folder. Pick a workspace first to list its folders, or leave the workspace empty to list your personal folders. Options load from the selected connection. |
| Sheet              | select (integer) | Yes      | Select the Smartsheet to operate on. Options load from the selected connection.                                                                                                                           |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Add Columns to Sheet

Add one or more columns to a Smartsheet with specified properties like type, title, options, and formatting. Supports all column types including text, dates, picklists, contacts, and system columns.

#### Inputs

| Field              | Type             | Required | Description                                                                                                                                                                                                                                               |
| ------------------ | ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Workspace (filter) | select (integer) | No       | Optional. Narrow the Sheet list to one workspace. Leave empty to list every sheet. Options load from the selected connection.                                                                                                                             |
| Folder (filter)    | select (integer) | No       | Optional. Narrow the Sheet list further to one folder. Pick a workspace first to list its folders, or leave the workspace empty to list your personal folders. Options load from the selected connection.                                                 |
| Sheet              | select (integer) | Yes      | Select the Smartsheet to operate on. Options load from the selected connection.                                                                                                                                                                           |
| Columns Data       | dict\_array      | Yes      | Array of column objects to be added to the sheet. Each column can specify: - Title and type (TEXT\_NUMBER, DATE, PICKLIST, etc.) - Options for dropdown/picklist columns - Width and formatting - Validation and locking options - Position in the sheet. |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Add Rows to Sheet

Insert one or more rows into a Smartsheet with specified cell data. Accepts JSON input where column names are keys and cell values are values. Automatically converts column names to column IDs. Optionally attach files to rows by including '\_attachment\_url' in the row data.

#### Inputs

| Field              | Type             | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| ------------------ | ---------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Workspace (filter) | select (integer) | No       | Optional. Narrow the Sheet list to one workspace. Leave empty to list every sheet. Options load from the selected connection.                                                                                                                                                                                                                                                                                                                                                                                    |
| Folder (filter)    | select (integer) | No       | Optional. Narrow the Sheet list further to one folder. Pick a workspace first to list its folders, or leave the workspace empty to list your personal folders. Options load from the selected connection.                                                                                                                                                                                                                                                                                                        |
| Sheet              | select (integer) | Yes      | Select the Smartsheet to operate on. Options load from the selected connection.                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| Rows Data (JSON)   | textarea         | Yes      | Row data to be added to the sheet as a JSON string. Provide a JSON array of objects where each object represents a row with column names as keys and cell values as values. Example: \[{"Name": "John", "Age": 30}, {"Name": "Jane", "Age": 25}]. For multi-select columns (MULTI\_PICKLIST, MULTI\_CONTACT\_LIST) pass a JSON array of the selected values, for example {"Risk Component": \["High", "Medium"]}. To attach files, add '\_attachment\_url' (and optionally '\_attachment\_filename') to any row. |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Create Sheet

Create a new sheet in Smartsheet.

#### Inputs

| Field              | Type             | Required | Description                                                                                                                                           |
| ------------------ | ---------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| Sheet Name         | string           | Yes      | Name for the new sheet.                                                                                                                               |
| Columns            | dict\_array      | No       | Initial columns for the sheet. Each column needs a title and type, and one column must be marked primary. Dropdown columns also take an options list. |
| Workspace (filter) | select (integer) | No       | Optional. Narrow the Sheet list to one workspace. Leave empty to list every sheet. Options load from the selected connection.                         |
| Template Sheet     | select (integer) | No       | Select a template or existing sheet to create the new sheet from. Options load from the selected connection.                                          |
| Folder             | select (integer) | No       | Folder where the sheet should be created. Either folder or workspace must be provided. Options load from the selected connection.                     |
| Workspace          | select (integer) | No       | Workspace where the sheet should be created at the top level. Either folder or workspace must be provided. Options load from the selected connection. |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Upload Attachment to Row

Download a file from a URL and attach it to a specific row in Smartsheet. Maximum file size is 30 MB.

#### Inputs

| Field                | Type             | Required | Description                                                                                                                                                                                               |
| -------------------- | ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Workspace (filter)   | select (integer) | No       | Optional. Narrow the Sheet list to one workspace. Leave empty to list every sheet. Options load from the selected connection.                                                                             |
| Folder (filter)      | select (integer) | No       | Optional. Narrow the Sheet list further to one folder. Pick a workspace first to list its folders, or leave the workspace empty to list your personal folders. Options load from the selected connection. |
| Sheet                | select (integer) | Yes      | Select the Smartsheet to operate on. Options load from the selected connection.                                                                                                                           |
| Row                  | select (integer) | Yes      | Select the row to operate on. Options load from the selected connection.                                                                                                                                  |
| File URL             | string           | Yes      | URL of the file to download and attach.                                                                                                                                                                   |
| File Name (Optional) | string           | No       | Optional custom filename. If not provided, extracted from the URL.                                                                                                                                        |

#### Outputs

| Field           | Type    | Description                                 |
| --------------- | ------- | ------------------------------------------- |
| Attachment ID   | integer | The unique ID of the created attachment.    |
| Attachment Name | string  | The name of the attached file.              |
| Attachment Type | string  | The type of the attachment (FILE).          |
| MIME Type       | string  | The MIME type of the attached file.         |
| Size (Bytes)    | integer | Size of the attached file in bytes.         |
| Row ID          | integer | The ID of the row the file was attached to. |

### Get Sheet

Retrieve a sheet, including its columns and rows with their cell values. Use Row IDs, Row Numbers or Column IDs to read only part of a large sheet. Rows are paginated at 100 per page by default.

#### Inputs

| Field              | Type             | Required | Description                                                                                                                                                                                                                                            |
| ------------------ | ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Workspace (filter) | select (integer) | No       | Optional. Narrow the Sheet list to one workspace. Leave empty to list every sheet. Options load from the selected connection.                                                                                                                          |
| Folder (filter)    | select (integer) | No       | Optional. Narrow the Sheet list further to one folder. Pick a workspace first to list its folders, or leave the workspace empty to list your personal folders. Options load from the selected connection.                                              |
| Sheet              | select (integer) | Yes      | Select the Smartsheet to operate on. Options load from the selected connection.                                                                                                                                                                        |
| Include            | string           | No       | A comma-separated list of optional elements to include in the response: attachments, columnType, crossSheetReferences, discussions, filters, filterDefinitions, format, ganttConfig, objectValue, ownerInfo, proofs, rowPermalink, source, writerInfo. |
| Exclude            | string           | No       | A comma-separated list of elements to leave out of the response: filteredOutRows, linkInFromCellDetails, linksOutToCellsDetails, nonexistentCells.                                                                                                     |
| Row IDs            | string           | No       | A comma-separated list of row IDs to return. Leave empty to return all rows.                                                                                                                                                                           |
| Row Numbers        | string           | No       | A comma-separated list of row numbers to return. Non-existent row numbers are ignored.                                                                                                                                                                 |
| Column IDs         | string           | No       | A comma-separated list of column IDs to return. Leave empty to return all columns.                                                                                                                                                                     |
| Level              | integer          | No       | Set to 2 together with an Include value of objectValue to read multi-select picklist and multi-contact columns. Leave at 0 for text-only values. Default: 0.                                                                                           |
| Page               | integer          | No       | Which page of rows to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page is returned. Minimum: 1. Default: 1.                                                                        |
| Page Size          | integer          | No       | The maximum number of rows to return per page. Defaults to 100. A sheet larger than one page requires further requests to read in full. Default: 100.                                                                                                  |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Get Row

Retrieve a single row from a sheet, including its cell values. Use this when you already know the row you need, rather than reading the whole sheet.

#### Inputs

| Field              | Type             | Required | Description                                                                                                                                                                                               |
| ------------------ | ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Workspace (filter) | select (integer) | No       | Optional. Narrow the Sheet list to one workspace. Leave empty to list every sheet. Options load from the selected connection.                                                                             |
| Folder (filter)    | select (integer) | No       | Optional. Narrow the Sheet list further to one folder. Pick a workspace first to list its folders, or leave the workspace empty to list your personal folders. Options load from the selected connection. |
| Sheet              | select (integer) | Yes      | Select the Smartsheet to operate on. Options load from the selected connection.                                                                                                                           |
| Row                | select (integer) | Yes      | Select the row to operate on. Options load from the selected connection.                                                                                                                                  |
| Include            | string           | No       | A comma-separated list of optional elements to include in the response: attachments, columns, columnType, discussions, filters, format, objectValue, proofs, rowPermalink, writerInfo.                    |
| Exclude            | string           | No       | A comma-separated list of elements to leave out of the response: filteredOutRows, linkInFromCellDetails, linksOutToCellsDetails, nonexistentCells.                                                        |
| Level              | integer          | No       | Set to 2 together with an Include value of objectValue to read multi-select picklist and multi-contact columns. Leave at 0 for text-only values. Default: 0.                                              |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### List Columns

Get the columns of a sheet, including each column's exact title, type and — for dropdown columns — the list of allowed values. Use this to discover a sheet's structure before writing rows to it.

#### Inputs

| Field              | Type             | Required | Description                                                                                                                                                                                               |
| ------------------ | ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Workspace (filter) | select (integer) | No       | Optional. Narrow the Sheet list to one workspace. Leave empty to list every sheet. Options load from the selected connection.                                                                             |
| Folder (filter)    | select (integer) | No       | Optional. Narrow the Sheet list further to one folder. Pick a workspace first to list its folders, or leave the workspace empty to list your personal folders. Options load from the selected connection. |
| Sheet              | select (integer) | Yes      | Select the Smartsheet to operate on. Options load from the selected connection.                                                                                                                           |
| Level              | integer          | No       | Set to 2 to see multi-select picklist and multi-contact columns as their own types. Leave at 0 for the backwards-compatible text representation. Default: 0.                                              |
| Page               | integer          | No       | Which page to return. Defaults to 1 if not specified. If you specify a value greater than the total number of pages, the last page of results is returned. Minimum: 1. Default: 1.                        |
| Page Size          | integer          | No       | The maximum number of columns to return per page. Defaults to 100. Sheets with more columns than this require further requests to read in full. Default: 100.                                             |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Update Rows

Update cell values on existing rows in a sheet. Identify each row by its Id and name the columns you want to change by their exact titles; columns you leave out keep their current values.

#### Inputs

| Field              | Type             | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| ------------------ | ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Workspace (filter) | select (integer) | No       | Optional. Narrow the Sheet list to one workspace. Leave empty to list every sheet. Options load from the selected connection.                                                                                                                                                                                                                                                                                                                                                     |
| Folder (filter)    | select (integer) | No       | Optional. Narrow the Sheet list further to one folder. Pick a workspace first to list its folders, or leave the workspace empty to list your personal folders. Options load from the selected connection.                                                                                                                                                                                                                                                                         |
| Sheet              | select (integer) | Yes      | Select the Smartsheet to operate on. Options load from the selected connection.                                                                                                                                                                                                                                                                                                                                                                                                   |
| Rows Data (JSON)   | textarea         | Yes      | Rows to update as a JSON string. Provide a JSON array of objects where each object has an 'id' key with the row Id, plus a key per column you want to change, named exactly as the column is titled. Columns you leave out keep their current values. Example: \[{"id": 5225480965908356, "Status": "Approved"}]. For multi-select columns (MULTI\_PICKLIST, MULTI\_CONTACT\_LIST) pass a JSON array of the selected values, for example {"Risk Component": \["High", "Medium"]}. |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Delete Rows

Permanently delete rows from a sheet by their Ids. This also removes the rows' attachments and discussions and cannot be undone.

#### Inputs

| Field                 | Type             | Required | Description                                                                                                                                                                                               |
| --------------------- | ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Workspace (filter)    | select (integer) | No       | Optional. Narrow the Sheet list to one workspace. Leave empty to list every sheet. Options load from the selected connection.                                                                             |
| Folder (filter)       | select (integer) | No       | Optional. Narrow the Sheet list further to one folder. Pick a workspace first to list its folders, or leave the workspace empty to list your personal folders. Options load from the selected connection. |
| Sheet                 | select (integer) | Yes      | Select the Smartsheet to operate on. Options load from the selected connection.                                                                                                                           |
| Row IDs               | string           | Yes      | A comma-separated list of the row Ids to delete. Deletion is permanent, and deleting a parent row also deletes its child rows.                                                                            |
| Ignore Rows Not Found | boolean          | No       | If enabled, row Ids that no longer exist are skipped instead of failing the whole request. Default: false.                                                                                                |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Get Folder

Retrieve a folder and list what it contains: sheets, sub-folders, reports, dashboards and templates.

#### Inputs

| Field              | Type             | Required | Description                                                                                                                   |
| ------------------ | ---------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------- |
| Workspace (filter) | select (integer) | No       | Optional. Narrow the Sheet list to one workspace. Leave empty to list every sheet. Options load from the selected connection. |
| Folder             | select (integer) | Yes      | Select the folder to retrieve. Options load from the selected connection.                                                     |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Get Workspace

Retrieve a workspace and list what it contains: sheets, folders, reports and dashboards. Enable Load All to include items nested inside its folders.

#### Inputs

| Field     | Type             | Required | Description                                                                                                                                      |
| --------- | ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| Workspace | select (integer) | Yes      | Select the workspace to retrieve. Options load from the selected connection.                                                                     |
| Load All  | boolean          | No       | If enabled, include everything in the workspace including items inside its folders. Otherwise only top-level items are returned. Default: false. |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### List Row Attachments

List the files attached to a row, with each attachment's name, type and size. Use this to discover what a row already has attached to it.

#### Inputs

| Field              | Type             | Required | Description                                                                                                                                                                                               |
| ------------------ | ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Workspace (filter) | select (integer) | No       | Optional. Narrow the Sheet list to one workspace. Leave empty to list every sheet. Options load from the selected connection.                                                                             |
| Folder (filter)    | select (integer) | No       | Optional. Narrow the Sheet list further to one folder. Pick a workspace first to list its folders, or leave the workspace empty to list your personal folders. Options load from the selected connection. |
| Sheet              | select (integer) | Yes      | Select the Smartsheet to operate on. Options load from the selected connection.                                                                                                                           |
| Row                | select (integer) | Yes      | Select the row to operate on. Options load from the selected connection.                                                                                                                                  |
| Page               | integer          | No       | Which page to return. Defaults to 1 if not specified. Minimum: 1. Default: 1.                                                                                                                             |
| Page Size          | integer          | No       | The maximum number of attachments to return per page. Defaults to 100. Default: 100.                                                                                                                      |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Get Sheet Summary

Read a sheet's summary fields — the named metadata fields shown beside the grid, which many templates use to hold project details. Requires a Smartsheet Business or Enterprise plan.

#### Inputs

| Field              | Type             | Required | Description                                                                                                                                                                                               |
| ------------------ | ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Workspace (filter) | select (integer) | No       | Optional. Narrow the Sheet list to one workspace. Leave empty to list every sheet. Options load from the selected connection.                                                                             |
| Folder (filter)    | select (integer) | No       | Optional. Narrow the Sheet list further to one folder. Pick a workspace first to list its folders, or leave the workspace empty to list your personal folders. Options load from the selected connection. |
| Sheet              | select (integer) | Yes      | Select the Smartsheet to operate on. Options load from the selected connection.                                                                                                                           |
| Include            | string           | No       | A comma-separated list of optional elements to include: format, writerInfo.                                                                                                                               |
| Exclude            | string           | No       | When set to displayValue, excludes that field from the response.                                                                                                                                          |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

### Update Cell

Update the value of one cell in a sheet.

#### Inputs

| Field              | Type             | Required | Description                                                                                                                                                                                               |
| ------------------ | ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Workspace (filter) | select (integer) | No       | Optional. Narrow the Sheet list to one workspace. Leave empty to list every sheet. Options load from the selected connection.                                                                             |
| Folder (filter)    | select (integer) | No       | Optional. Narrow the Sheet list further to one folder. Pick a workspace first to list its folders, or leave the workspace empty to list your personal folders. Options load from the selected connection. |
| Sheet              | select (integer) | Yes      | Select the Smartsheet to operate on. Options load from the selected connection.                                                                                                                           |
| Row                | select (integer) | Yes      | Select the row to operate on. Options load from the selected connection.                                                                                                                                  |
| Column             | select (string)  | Yes      | Select the column of the cell to update. Options load from the selected connection.                                                                                                                       |
| Value              | string           | No       | The new value for the cell. For multi-select columns enter a JSON array, for example \["High", "Medium"]. Leave empty to clear the cell.                                                                  |

#### Outputs

| Field       | Type    | Description                  |
| ----------- | ------- | ---------------------------- |
| Status Code | integer | Status code of the response. |
| Headers     | dict    | Headers of the response.     |
| Body        | object  | Body of the response.        |

## Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/smartsheet.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
