> 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/microsoft-excel.md).

# Microsoft Excel

Microsoft Excel in SharePoint is a collaborative spreadsheet application that enables teams to create, edit, and share spreadsheets online. Supports comprehensive Excel 365 operations including table management, sheet operations, and workbook management.

### Connectors

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

| Connector          | Authentication |
| ------------------ | -------------- |
| Excel (SharePoint) | OAuth sign-in  |
| Excel (OneDrive)   | OAuth sign-in  |

#### Excel (SharePoint)

Connect to Excel files stored in SharePoint using OAuth2 authentication. Supports spreadsheet operations on SharePoint-hosted workbooks.

**Set up in Microsoft Excel**

1. Sign in with your Microsoft account that has access to the SharePoint site holding your workbooks.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Excel (SharePoint)**.
2. Select **Connect**, sign in to the provider account, and review the requested access. Complete authorization to return to StackAI.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

StackAI obtains the OAuth credentials during sign-in. You do not need to paste an access token or refresh token.

**Provider documentation:** [Setup reference](https://learn.microsoft.com/en-us/graph/api/resources/excel).

#### Excel (OneDrive)

Connect to Excel files stored in OneDrive using OAuth2 authentication. Supports spreadsheet operations on OneDrive-hosted workbooks.

**Set up in Microsoft Excel**

1. Sign in with the Microsoft account whose OneDrive holds your workbooks.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Excel (OneDrive)**.
2. Select **Connect**, sign in to the provider account, and review the requested access. Complete authorization to return to StackAI.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

StackAI obtains the OAuth credentials during sign-in. You do not need to paste an access token or refresh token.

**Provider documentation:** [Setup reference](https://learn.microsoft.com/en-us/graph/api/resources/excel).

#### 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.

### Use an action

1. Add the required **Microsoft Excel** 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

#### Create Sheet

Create a new sheet in an Excel workbook

**Inputs**

| Field    | Type            | Required | Description                                                                                                                    |
| -------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Site     | select (string) | Yes      | Select the site (SharePoint or OneDrive), or enter the site ID manually. Options load from the selected connection.            |
| Workbook | select (string) | Yes      | Select the Excel workbook to create a sheet in, or enter the workbook URL manually. Options load from the selected connection. |
| Sheet    | string          | Yes      | Enter the name for the new sheet.                                                                                              |

**Outputs**

| Field      | Type   | Description                    |
| ---------- | ------ | ------------------------------ |
| Status     | string | Status of the operation.       |
| Sheet ID   | string | The ID of the created sheet.   |
| Sheet Name | string | The name of the created sheet. |
| Message    | string | Message about the operation.   |

#### Clear Sheet

Clear data from an Excel sheet in SharePoint

**Inputs**

| Field                    | Type            | Required | Description                                                                                                                             |
| ------------------------ | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| Site                     | select (string) | Yes      | Select the site (SharePoint or OneDrive), or enter the site ID manually. Options load from the selected connection.                     |
| Workbook                 | select (string) | Yes      | Select the Excel workbook containing the sheet to clear, or enter the workbook URL manually. Options load from the selected connection. |
| Sheet                    | select (string) | Yes      | Enter the name of the worksheet to clear. Options load from the selected connection.                                                    |
| Range Address (Optional) | string          | No       | Optional: Specific range to clear (e.g., A1:D10). Leave empty to clear entire sheet.                                                    |

**Outputs**

| Field         | Type   | Description                  |
| ------------- | ------ | ---------------------------- |
| Status        | string | Status of the operation.     |
| Cleared Range | string | The range that was cleared.  |
| Message       | string | Message about the operation. |

#### Delete Sheet

Delete a sheet from an Excel workbook in SharePoint

**Inputs**

| Field    | Type            | Required | Description                                                                                                                              |
| -------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| Site     | select (string) | Yes      | Select the site (SharePoint or OneDrive), or enter the site ID manually. Options load from the selected connection.                      |
| Workbook | select (string) | Yes      | Select the Excel workbook containing the sheet to delete, or enter the workbook URL manually. Options load from the selected connection. |
| Sheet    | select (string) | Yes      | Select the worksheet to delete, or enter the sheet name manually. Options load from the selected connection.                             |

**Outputs**

| Field   | Type   | Description                  |
| ------- | ------ | ---------------------------- |
| Status  | string | Status of the operation.     |
| Message | string | Message about the operation. |

#### List Sheets

List all worksheets in an Excel workbook

**Inputs**

| Field    | Type            | Required | Description                                                                                                         |
| -------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------- |
| Site     | select (string) | Yes      | Select the site (SharePoint or OneDrive), or enter the site ID manually. Options load from the selected connection. |
| Workbook | select (string) | Yes      | Select the Excel workbook, or enter the workbook URL manually. Options load from the selected connection.           |

**Outputs**

| Field       | Type     | Description                       |
| ----------- | -------- | --------------------------------- |
| Status      | string   | Status of the operation.          |
| Sheets      | textarea | The sheets data as JSON.          |
| Sheet Count | number   | Number of sheets in the workbook. |
| Message     | string   | Message about the operation.      |

#### Get Sheet by ID

Get a specific sheet by its ID or name from an Excel workbook

**Inputs**

| Field        | Type            | Required | Description                                                                                                                                    |
| ------------ | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| Site         | select (string) | Yes      | Select the site (SharePoint or OneDrive), or enter the site ID manually. Options load from the selected connection.                            |
| Workbook     | select (string) | Yes      | Select the Excel workbook, or enter the workbook URL manually. Options load from the selected connection.                                      |
| Search By    | select (string) | Yes      | Choose whether to find the worksheet by ID or name. Available values: ID, Name.                                                                |
| Worksheet ID | string          | No       | The unique ID of the worksheet in GUID format with curly braces (required when searching by ID, e.g., {75A18F35-34AA-4F44-97CC-FDC3C05D9F40}). |
| Sheet        | select (string) | No       | Select the worksheet, or enter the name manually (required when searching by Name). Options load from the selected connection.                 |

**Outputs**

| Field          | Type   | Description                                    |
| -------------- | ------ | ---------------------------------------------- |
| Status         | string | Status of the operation.                       |
| Worksheet ID   | string | The unique ID of the worksheet.                |
| Worksheet Name | string | The name of the worksheet.                     |
| Position       | number | The position of the worksheet in the workbook. |
| Visibility     | string | The visibility state of the worksheet.         |
| Message        | string | Message about the operation.                   |

#### Rename Sheet

Rename a sheet in an Excel workbook

**Inputs**

| Field             | Type            | Required | Description                                                                                                         |
| ----------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------- |
| Site              | select (string) | Yes      | Select the site (SharePoint or OneDrive), or enter the site ID manually. Options load from the selected connection. |
| Workbook          | select (string) | Yes      | Select the Excel workbook, or enter the workbook URL manually. Options load from the selected connection.           |
| Rename Sheet With | select (string) | Yes      | Choose whether to find the sheet by name or index. Available values: Name, Index.                                   |
| Sheet Index       | integer         | No       | The index of the sheet to rename (1-based indexing, e.g., 1 for first sheet, 2 for second).                         |
| Sheet             | select (string) | No       | Select the sheet to rename, or enter the current name manually. Options load from the selected connection.          |
| New Sheet Name    | string          | Yes      | The new name for the sheet.                                                                                         |

**Outputs**

| Field    | Type   | Description                  |
| -------- | ------ | ---------------------------- |
| Status   | string | Status of the operation.     |
| Message  | string | Message about the operation. |
| Old Name | string | Previous name of the sheet.  |
| New Name | string | New name of the sheet.       |

#### Create Table

Create a table in an Excel sheet

**Inputs**

| Field                  | Type            | Required | Description                                                                                                                                                                              |
| ---------------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Site                   | select (string) | Yes      | Select the site (SharePoint or OneDrive), or enter the site ID manually. Options load from the selected connection.                                                                      |
| Workbook               | select (string) | Yes      | Select the Excel workbook, or enter the workbook URL manually. Options load from the selected connection.                                                                                |
| Sheet                  | select (string) | Yes      | Select the worksheet or enter the sheet name. Options load from the selected connection.                                                                                                 |
| Values                 | textarea        | Yes      | Enter the values to create the table with (JSON)Example: \[{"col1": "val1", "col2": 2}, {"col1": "val2", "col2": 3}] or \[\["val1", 2], \["val2", 3]] or {"col1": "val1", "col2": 2}.    |
| Starting Cell          | string          | Yes      | The top-left cell where the table will start (used when table range is not specified). Default: A1.                                                                                      |
| Table Range (Optional) | string          | No       | The Excel range where the table will be created (e.g., A1:D10, B2:F20). If not provided, the range will be calculated automatically from the data size starting from the specified cell. |

**Outputs**

| Field      | Type   | Description                      |
| ---------- | ------ | -------------------------------- |
| Status     | string | Status of the operation.         |
| Message    | string | Message about the operation.     |
| Table Name | string | Name of the created Excel table. |

#### Write to Sheet

Write data to a specific range in an Excel sheet. Overwrites any existing data in the target range.

**Inputs**

| Field               | Type            | Required | Description                                                                                                                                                                                                                             |
| ------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Site                | select (string) | Yes      | Select the site (SharePoint or OneDrive), or enter the site ID manually. Options load from the selected connection.                                                                                                                     |
| Workbook            | select (string) | Yes      | Select the Excel workbook, or enter the workbook URL manually. Options load from the selected connection.                                                                                                                               |
| Sheet               | select (string) | Yes      | Select the worksheet, or enter the sheet name manually. Options load from the selected connection.                                                                                                                                      |
| Values              | textarea        | Yes      | Enter the values to write to the sheet (JSON). Dictionary format automatically includes headers. Examples: \[{"col1": "val1", "col2": 2}, {"col1": "val2", "col2": 3}] or \[\["val1", 2], \["val2", 3]] or {"col1": "val1", "col2": 2}. |
| Target Range        | string          | Yes      | Starting cell (e.g., 'A1') or explicit range (e.g., 'A1:D10'). Empty: range is auto-calculated from data size. A1: range is auto-calculated from top left cell. A1:D10: range is explicit. Will OVERWRITE existing data. Default: A1.   |
| Formulas (Optional) | textarea        | No       | Optional: 2D array of formulas matching data dimensions. Use null for cells that should use values instead. Example for 2x2 data: \[\[null, "=A1\*2"], \["=B1+1", null]].                                                               |

**Outputs**

| Field   | Type   | Description                  |
| ------- | ------ | ---------------------------- |
| Status  | string | Status of the operation.     |
| Message | string | Message about the operation. |

#### Find Row

Find rows containing specific search criteria in an Excel sheet.

**Inputs**

| Field          | Type            | Required | Description                                                                                                         |
| -------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------- |
| Site           | select (string) | Yes      | Select the site (SharePoint or OneDrive), or enter the site ID manually. Options load from the selected connection. |
| Workbook       | select (string) | Yes      | Select the Excel workbook, or enter the workbook URL manually. Options load from the selected connection.           |
| Sheet          | select (string) | Yes      | Select the worksheet, or enter the sheet name manually. Options load from the selected connection.                  |
| Search Term    | string          | Yes      | Enter the text or value to search for in the sheet.                                                                 |
| Column Filter  | string          | No       | Limit search to specific column (optional, e.g., A, B, C, AA, AB).                                                  |
| Case Sensitive | boolean         | No       | Whether the search should be case sensitive. Default: false.                                                        |

**Outputs**

| Field      | Type     | Description                  |
| ---------- | -------- | ---------------------------- |
| Status     | string   | Status of the operation.     |
| Found Rows | textarea | The matching rows as JSON.   |
| Row Count  | number   | Number of rows found.        |
| Message    | string   | Message about the operation. |

#### Get Cells in Range

Get cell values from an Excel sheet

**Inputs**

| Field      | Type            | Required | Description                                                                                                         |
| ---------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------- |
| Site       | select (string) | Yes      | Select the site (SharePoint or OneDrive), or enter the site ID manually. Options load from the selected connection. |
| Workbook   | select (string) | Yes      | Select the Excel workbook, or enter the workbook URL manually. Options load from the selected connection.           |
| Sheet      | select (string) | Yes      | Select the worksheet, or enter the sheet name manually. Options load from the selected connection.                  |
| Cell Range | string          | Yes      | Enter the Excel range to read (single cell or range, e.g., A1, B2:C5, A1:A10).                                      |

**Outputs**

| Field             | Type     | Description                  |
| ----------------- | -------- | ---------------------------- |
| Status            | string   | Status of the operation.     |
| Cell Values       | textarea | The cell values as JSON.     |
| Range Information | string   | Information about the range. |
| Message           | string   | Message about the operation. |

#### Get Row by Index

Get a specific row by index from an Excel worksheet

**Inputs**

| Field        | Type            | Required | Description                                                                                                            |
| ------------ | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| Site         | select (string) | Yes      | Select the site (SharePoint or OneDrive), or enter the site ID manually. Options load from the selected connection.    |
| Workbook     | select (string) | Yes      | Select the Excel workbook, or enter the workbook URL manually. Options load from the selected connection.              |
| Sheet        | select (string) | Yes      | Select the worksheet to get the row from, or enter the sheet name manually. Options load from the selected connection. |
| Row Number   | integer         | Yes      | The row number to retrieve (1-based indexing, e.g., 1 for first row, 2 for second row).                                |
| Start Column | string          | No       | Starting column (e.g., A, B, C). Defaults to A. Default: A.                                                            |
| End Column   | string          | No       | Ending column (e.g., Z, AA, AB). Defaults to Z. Default: Z.                                                            |

**Outputs**

| Field        | Type     | Description                          |
| ------------ | -------- | ------------------------------------ |
| Status       | string   | Status of the operation.             |
| Row Data     | textarea | The row data as JSON array.          |
| Row Number   | number   | The retrieved row number.            |
| Column Range | string   | The column range that was retrieved. |
| Message      | string   | Message about the operation.         |

#### Read from Sheet

Read data from an Excel sheet

**Inputs**

| Field                    | Type            | Required | Description                                                                                                         |
| ------------------------ | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------- |
| Site                     | select (string) | Yes      | Select the site (SharePoint or OneDrive), or enter the site ID manually. Options load from the selected connection. |
| Workbook                 | select (string) | Yes      | Select the Excel workbook, or enter the workbook URL manually. Options load from the selected connection.           |
| Sheet                    | select (string) | Yes      | Select the worksheet to get rows from, or enter the sheet name manually. Options load from the selected connection. |
| Range Address (Optional) | string          | No       | Specific range to get rows from (leave empty to get all used rows).                                                 |

**Outputs**

| Field         | Type     | Description                      |
| ------------- | -------- | -------------------------------- |
| Status        | string   | Status of the operation.         |
| Rows          | textarea | The retrieved rows data as JSON. |
| Row Count     | number   | Number of rows retrieved.        |
| Range Address | string   | The range that was read.         |
| Message       | string   | Message about the operation.     |

#### Update Cell

Update a specific cell value in an Excel sheet by cell address

**Inputs**

| Field        | Type            | Required | Description                                                                                                                      |
| ------------ | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------- |
| Site         | select (string) | Yes      | Select the site (SharePoint or OneDrive), or enter the site ID manually. Options load from the selected connection.              |
| Workbook     | select (string) | Yes      | Select the Excel workbook, or enter the workbook URL manually. Options load from the selected connection.                        |
| Sheet        | select (string) | Yes      | Select the specific sheet/tab name in the workbook, or enter the sheet name manually. Options load from the selected connection. |
| Cell Address | string          | Yes      | Enter the cell address (e.g., A1, B2, C10, AA5).                                                                                 |
| Value        | string          | No       | Enter the new value for the cell (e.g., John Doe, 123, =SUM(A1:A10)). Leave empty to clear the cell. Default: .                  |

**Outputs**

| Field          | Type   | Description                        |
| -------------- | ------ | ---------------------------------- |
| Updated Range  | string | The range that was updated.        |
| Cell Address   | string | The cell address that was updated. |
| New Value      | string | The new value that was set.        |
| Status Message | string | Success message with details.      |

#### Update Row

Update a specific row in an Excel sheet with new data.

**Inputs**

| Field      | Type            | Required | Description                                                                                                         |
| ---------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------- |
| Site       | select (string) | Yes      | Select the site (SharePoint or OneDrive), or enter the site ID manually. Options load from the selected connection. |
| Workbook   | select (string) | Yes      | Select the Excel workbook, or enter the workbook URL manually. Options load from the selected connection.           |
| Sheet      | select (string) | Yes      | Select the worksheet, or enter the sheet name manually. Options load from the selected connection.                  |
| Row Index  | integer         | Yes      | Enter the row number to update (1-based indexing, e.g., 2 for second row).                                          |
| Row Values | textarea        | Yes      | Enter the values for the row (JSON array)Example: \["John Doe", 30, "New York", "<john@example.com>"].              |

**Outputs**

| Field         | Type   | Description                       |
| ------------- | ------ | --------------------------------- |
| Status        | string | Status of the operation.          |
| Message       | string | Message about the operation.      |
| Updated Range | string | The Excel range that was updated. |

#### Create Workbook

Create a new Excel workbook in SharePoint or OneDrive.

**Inputs**

| Field         | Type            | Required | Description                                                                                                                                      |
| ------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| Site          | select (string) | Yes      | Select the site (SharePoint or OneDrive) where to create the workbook, or enter the site ID manually. Options load from the selected connection. |
| Workbook Name | string          | Yes      | Enter the name for the new Excel workbook.                                                                                                       |
| Folder Path   | string          | No       | The folder path where to create the workbook (optional, defaults to root folder).                                                                |

**Outputs**

| Field         | Type   | Description                   |
| ------------- | ------ | ----------------------------- |
| Status        | string | Status of the operation.      |
| Message       | string | Message about the operation.  |
| Workbook ID   | string | ID of the created workbook.   |
| Workbook URL  | string | URL of the created workbook.  |
| Workbook Name | string | Name of the created workbook. |

#### List Workbooks

List all Excel workbooks from a SharePoint site

**Inputs**

| Field | Type            | Required | Description                                                                                                         |
| ----- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------- |
| Site  | select (string) | Yes      | Select the site (SharePoint or OneDrive), or enter the site ID manually. Options load from the selected connection. |

**Outputs**

| Field          | Type     | Description                  |
| -------------- | -------- | ---------------------------- |
| Status         | string   | Status of the operation.     |
| Workbooks      | textarea | The workbooks data as JSON.  |
| Workbook Count | number   | Number of workbooks found.   |
| Message        | string   | Message about the operation. |

#### Add Data to Table

Append rows to an existing table in an Excel sheet, using its current columns.

**Inputs**

| Field      | Type            | Required | Description                                                                                                                                                                                                                                                                                                                                                                                         |
| ---------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Site       | select (string) | Yes      | Select the site (SharePoint or OneDrive), or enter the site ID manually. Options load from the selected connection.                                                                                                                                                                                                                                                                                 |
| Workbook   | select (string) | Yes      | Select the Excel workbook, or enter the workbook URL manually. Options load from the selected connection.                                                                                                                                                                                                                                                                                           |
| Sheet      | select (string) | Yes      | Enter the specific sheet name in the workbook. Options load from the selected connection.                                                                                                                                                                                                                                                                                                           |
| Table Name | string          | Yes      | Enter the name of the table to append data to.                                                                                                                                                                                                                                                                                                                                                      |
| Values     | textarea        | Yes      | Enter the values to add to the table (JSON). Example: \[{"col1": "val1", "col2": 2}, {"col1": "val2", "col2": 3}] or \[\["val1", 2], \["val2", 3]] or {"col1": "val1", "col2": 2} Keys must match the table's existing column names. Keys with no matching column are ignored and no error is raised. Columns with no matching key are written as empty cells. This action does not create columns. |

**Outputs**

| Field   | Type   | Description                  |
| ------- | ------ | ---------------------------- |
| Status  | string | Status of the operation.     |
| Message | string | Message about the operation. |

#### Read Workbook

Read all data from every sheet in an Excel workbook

**Inputs**

| Field    | Type            | Required | Description                                                                                                         |
| -------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------- |
| Site     | select (string) | Yes      | Select the site (SharePoint or OneDrive), or enter the site ID manually. Options load from the selected connection. |
| Workbook | select (string) | Yes      | Select the Excel workbook, or enter the workbook URL manually. Options load from the selected connection.           |

**Outputs**

| Field           | Type     | Description                             |
| --------------- | -------- | --------------------------------------- |
| Status          | string   | Status of the operation.                |
| Sheets          | textarea | All sheets and their row data as JSON.  |
| Sheet Count     | number   | Number of sheets in the workbook.       |
| Total Row Count | number   | Total number of rows across all sheets. |
| Message         | string   | Message about the operation.            |

### Important behavior

If an operation is denied, check the connection’s granted permissions and the account’s access in the provider. Reauthorize the connection when it needs additional permissions.

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/microsoft-excel.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.
