Skip to main content

Microsoft Excel Component

Parse and build .xlsx files (spreadsheets)

Component key: ms-excel

Changelog ↓

Description​

Microsoft Excel is a spreadsheet application developed by Microsoft. It features calculation, graphing tools, pivot tables, and a macro programming language called Visual Basic for Applications. This component allows you to read and build .xlsx files. (spreadsheets)

Connections​

OAuth 2.0​

key: ms-excel-oauth

To connect Microsoft Excel, create and configure an App Registration in the Microsoft Entra admin center.

Prerequisites​

  • A Microsoft 365 account with access to SharePoint or OneDrive
  • Administrator access to Microsoft Entra (Azure Active Directory)

Setup Steps​

  1. Navigate to Microsoft Entra > Identity > Applications > App registrations
  2. Select New registration
  3. Configure the basic settings:
    • Name: Provide a descriptive name for the application
    • Supported account types: Select Accounts in any organizational directory (Any Azure AD directory - Multitenant)
    • Redirect URI: Select Web platform and add https://oauth2.prismatic.io/callback
  4. Click Register to create the app registration
  5. From the Overview page, copy the Application (client) ID
  6. Navigate to Certificates & Secrets > Client secrets tab
  7. Click New client secret, provide a description, select an expiration period, and click Add
  8. Copy the secret Value immediately -- it cannot be retrieved later
  9. Navigate to API Permissions and click Add a permission
  10. Select Microsoft Graph > Delegated permissions and select all permissions required for the integration
Refresh Token Support

Include the offline_access scope in the app registration. It is essential for maintaining the OAuth connection and receiving refresh tokens. Without it, re-authentication is required every hour.

Configure the Connection​

Create a connection of type Microsoft Excel OAuth 2.0:

  • Client ID: The Application (client) ID from the app registration Overview page
  • Client Secret: The secret Value created above
  • Scopes: Space-separated list of OAuth 2.0 permission scopes. The default value covers common file and site operations: 
    Files.ReadWrite.All Sites.Read.All Sites.ReadWrite.All offline_access
    Refer to Microsoft Graph permissions reference for additional scope information

For non-multitenant app registrations, replace the default Authorize URL and Token URL with tenant-specific values:

  • Authorize URL: https://login.microsoftonline.com/{tenant-id}/oauth2/v2.0/authorize
  • Token URL: https://login.microsoftonline.com/{tenant-id}/oauth2/v2.0/token
InputNotesExample
Authorize URL

The OAuth 2.0 Authorization URL for Microsoft Excel.

https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Client ID

The Client ID from the OAuth application registration in the Azure Portal.

Client Secret

The Client Secret from the OAuth application registration in the Azure Portal.

Scopes

Space-separated list of OAuth 2.0 permission scopes required for the integration.

Files.ReadWrite.All Sites.Read.All Sites.ReadWrite.All offline_access
Source

The source from which the workbooks will be listed.

Token URL

The OAuth 2.0 Token URL for Microsoft Excel.

https://login.microsoftonline.com/common/oauth2/v2.0/token

Data Sources​

Select Column​

Select a column from the list of columns. | key: selectColumn | type: picklist

InputNotesExample
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Table ID

The ID or name of the table to list columns from.

{12B25C6E-59A4-4316-BE2E-325B2C8EDD50}
Workbook ID

The ID of the workbook that contains the worksheet to list columns from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to list columns from.

{00000000-0001-0000-0000-000000000000}

Select Drive or Site​

Select a drive or site from the list of drives and sites. | key: selectDriveOrSite | type: picklist

InputNotesExample
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Select Table​

Select a table from the list of tables. | key: selectTable | type: picklist

InputNotesExample
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Workbook ID

The ID of the workbook that contains the worksheet to list tables from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to list tables from.

{00000000-0001-0000-0000-000000000000}

Select Workbook​

Select a workbook from the list of workbooks. | key: selectWorkbook | type: picklist

InputNotesExample
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from. Use this or Path.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
List or Item ID

The SharePoint list ID or OneDrive item ID used to scope the workbook search.

01J363WTN6Y2GOVW7725BZO354PWSELRRZ
Path

The path to the file or folder within the drive. Use this or Drive or Site ID.

/drive/root:/folder/file.xlsx

Select Worksheet​

Select a worksheet from the list of worksheets. | key: selectWorksheet | type: picklist

InputNotesExample
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Workbook ID

The ID of the workbook to retrieve.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ

Actions​

Build Spreadsheet​

Creates a buffer containing a spreadsheet made from a 2D JavaScript array. | key: build

InputNotesExample
Create Options

Configuration options for spreadsheet generation, such as column widths. Accepts a JSON object with node-xlsx compatible options.

File Name

The name to assign to the generated spreadsheet file.

mySheet
Spreadsheet Data

A 2D array of cell values to insert into the spreadsheet. Each inner array represents a row.

{
  "data": {}
}

Build Spreadsheet with Multiple Sheets​

Creates a buffer containing multiple spreadsheets made from a 3D JavaScript array. | key: buildMultiple

InputNotesExample
Structured Sheet Names

A JSON array of sheet names as an alternative to the Sheet Names input. Takes priority over the Sheet Names input when both are provided.

Create Options

Configuration options for spreadsheet generation, such as column widths. Accepts a JSON object with node-xlsx compatible options.

Spreadsheet Data

A 3D array of sheet data. Each top-level array is a sheet, containing rows of cell values.

Sheet Names

The name to assign to each sheet in the spreadsheet.

mySheet

{
  "data": {}
}

Clear Cell Range​

Clear range values such as format, fill, and border. | key: clearCellRange

InputNotesExample
Address

The address of the range to update.

A1:B2
Apply To

Determines the type of clear action.

Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Workbook ID

The ID of the workbook that contains the worksheet to clear cells from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to clear cells from.

{00000000-0001-0000-0000-000000000000}

{
  "data": "CLEARED SUCCESSFULLY"
}

Create Column​

Creates a column object inside a worksheet table. | key: createColumn

InputNotesExample
Column ID

Specifies the relative position of the new column. The previous column at this position is shifted to the right. The index value should be equal to or less than the last column's index value, so it can't be used to append a column at the end of the table. Zero-indexed.

1
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Table ID

The ID or name of the table to create the column in.

{12B25C6E-59A4-4316-BE2E-325B2C8EDD50}
Values

A two-dimensional array of unformatted values of the table column.

Workbook ID

The ID of the workbook that contains the worksheet to create the column in.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to create the column in.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "values": [
      [
        "Column1"
      ],
      [
        "Test"
      ]
    ],
    "id": "1",
    "index": 0,
    "name": "Column1"
  }
}

Create Multiple Rows​

Adds rows to the end of a table. | key: createMultipleRows

InputNotesExample
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Row Index

Specifies the relative position of the new row. If null, the addition happens at the end. Any rows below the inserted row are shifted downwards. Zero-indexed.

0
Table ID

The ID or name of the table to create the row in.

{12B25C6E-59A4-4316-BE2E-325B2C8EDD50}
Values

A 2D array of values for the row cells.

Workbook ID

The ID of the workbook that contains the worksheet to create the row in.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to create the row in.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "index": 99,
    "values": "values-value"
  }
}

Create Row​

Creates a row object inside a worksheet table. | key: createRow

InputNotesExample
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Row Index

Specifies the relative position of the new row. If null, the addition happens at the end. Any rows below the inserted row are shifted downwards. Zero-indexed.

0
Table ID

The ID or name of the table to create the row in.

{12B25C6E-59A4-4316-BE2E-325B2C8EDD50}
Values

A 2D array of values for the row cells.

Workbook ID

The ID of the workbook that contains the worksheet to create the row in.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to create the row in.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "index": 99,
    "values": "values-value"
  }
}

Create Table​

Creates a table object inside a worksheet. | key: createTable

InputNotesExample
Address

Address or name of the range object representing the data source. If the address doesn't contain a sheet name, the currently active sheet is used.

A1
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Has Headers

When true, indicates the data being imported has column labels. When false, Excel generates a header row and shifts data down by one row.

false
Workbook ID

The ID of the workbook that contains the worksheet to create the table in.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID of the worksheet to create the table in.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "id": "99",
    "name": "name-value",
    "showHeaders": true,
    "showTotals": true,
    "style": "style-value"
  }
}

Create Worksheet​

Creates a worksheet object inside a workbook. | key: createWorksheet

InputNotesExample
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Worksheet Name

The name shown on the worksheet tab in the workbook. Must be unique within the workbook.

Sheet1
Workbook ID

The ID of the workbook that contains the worksheet to update.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ

{
  "data": {
    "id": "id-value",
    "position": 99,
    "name": "name-value",
    "visibility": "visibility-value"
  }
}

Delete Cell Range​

Deletes the cells associated with the range. | key: deleteCellRange

InputNotesExample
Address

The address of the range to update.

A1:B2
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Shift

Specifies which way to shift the cells.

Workbook ID

The ID of the workbook that contains the worksheet to delete cells from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to delete cells from.

{00000000-0001-0000-0000-000000000000}

{
  "data": "DELETED SUCCESSFULLY"
}

Delete Column​

Deletes a column object from a worksheet table. | key: deleteColumn

InputNotesExample
Column ID

The id or name of the column to delete.

1
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Table ID

The ID or name of the table to delete the column from.

{12B25C6E-59A4-4316-BE2E-325B2C8EDD50}
Workbook ID

The ID of the workbook that contains the worksheet to delete the column from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to delete the column from.

{00000000-0001-0000-0000-000000000000}

{
  "data": "DELETED SUCCESSFULLY"
}

Delete Table​

Deletes a table object from a worksheet. | key: deleteTable

InputNotesExample
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Table ID

The ID or name of the table to delete.

{12B25C6E-59A4-4316-BE2E-325B2C8EDD50}
Workbook ID

The ID of the workbook that contains the worksheet to delete the table from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to delete the table from.

{00000000-0001-0000-0000-000000000000}

{
  "data": "DELETED SUCCESSFULLY"
}

Delete Worksheet​

Deletes a worksheet from a workbook. | key: deleteWorksheet

InputNotesExample
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Workbook ID

The ID of the workbook that contains the worksheet to delete.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID of the worksheet to delete.

{00000000-0001-0000-0000-000000000000}

{
  "data": "DELETED SUCCESSFULLY"
}

Get Cell​

Retrieves a cell from a worksheet. | key: getCell

InputNotesExample
Column Index

The zero-based index of the column to access within the worksheet.

0
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Row Index

The zero-based index of the row to access within the worksheet.

0
Workbook ID

The ID of the workbook that contains the worksheet to list cells from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to list cells from.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "address": "address-value",
    "addressLocal": "addressLocal-value",
    "cellCount": 99,
    "columnCount": 99,
    "columnIndex": 99,
    "valueTypes": "valueTypes-value"
  }
}

Get Cell Range​

Retrieve the properties and relationships of a range object. | key: getCellRange

InputNotesExample
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Workbook ID

The ID of the workbook that contains the worksheet to list cells from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to list cells from.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "address": "address-value",
    "addressLocal": "addressLocal-value",
    "cellCount": 99,
    "columnCount": 99,
    "columnIndex": 99,
    "valueTypes": "valueTypes-value"
  }
}

Get Column​

Retrieves a column object from a worksheet table. | key: getColumn

InputNotesExample
Column ID

The ID or name of the column to retrieve.

1
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Table ID

The ID or name of the table to list column from.

{12B25C6E-59A4-4316-BE2E-325B2C8EDD50}
Workbook ID

The ID of the workbook that contains the worksheet to list column from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to list column from.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "values": [
      [
        "Column1"
      ],
      [
        "Test"
      ]
    ],
    "id": "1",
    "index": 0,
    "name": "Column1"
  }
}

Get Table​

Retrieves a table object from a worksheet. | key: getTable

InputNotesExample
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Table ID

The unique identifier or name of the table within the worksheet.

{12B25C6E-59A4-4316-BE2E-325B2C8EDD50}
Workbook ID

The ID of the workbook that contains the worksheet to get the table from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to get the table from.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "id": "99",
    "name": "name-value",
    "showHeaders": true,
    "showTotals": true,
    "style": "style-value"
  }
}

Get Worksheet​

Retrieves a worksheet object from a workbook. | key: getWorksheet

InputNotesExample
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Workbook ID

The ID of the workbook to retrieve.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to retrieve.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "id": "id-value",
    "position": 99,
    "name": "name-value",
    "visibility": "visibility-value"
  }
}

List Columns​

Retrieve a list of columns from a worksheet table. | key: listColumns

InputNotesExample
Expand

A comma-separated list of related resources to expand and include in the response.

members
Filter

An OData filter expression to narrow down results. For example: startswith(givenName,'J').

startswith(givenName,'J')
Format

The media format for the response. For example: json.

json
Order By

An OData orderBy expression to sort results. For example: displayName desc.

displayName desc
Search

A search string to filter results by matching against indexed properties.

pizza
Select

A comma-separated list of properties to include in the response. Reduces payload size.

givenName,surname
Skip

Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results.

10
Skip Token

Retrieves the next page of results from result sets that span multiple pages.

X%274453707402000100000017...
Top

The maximum number of results to return per page.

10
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Fetch All

When true, automatically fetches all pages of results using pagination.

false
Table ID

The ID or name of the table to list columns from.

{12B25C6E-59A4-4316-BE2E-325B2C8EDD50}
Workbook ID

The ID of the workbook that contains the worksheet to list columns from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to list columns from.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "value": [
      {
        "values": [
          [
            "Column1"
          ],
          [
            "Test"
          ]
        ],
        "id": "1",
        "index": 0,
        "name": "Column1"
      }
    ]
  }
}

List Rows​

Retrieve a list of rows from a worksheet table. | key: listRows

InputNotesExample
Expand

A comma-separated list of related resources to expand and include in the response.

members
Filter

An OData filter expression to narrow down results. For example: startswith(givenName,'J').

startswith(givenName,'J')
Format

The media format for the response. For example: json.

json
Order By

An OData orderBy expression to sort results. For example: displayName desc.

displayName desc
Search

A search string to filter results by matching against indexed properties.

pizza
Select

A comma-separated list of properties to include in the response. Reduces payload size.

givenName,surname
Skip

Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results.

10
Skip Token

Retrieves the next page of results from result sets that span multiple pages.

X%274453707402000100000017...
Top

The maximum number of results to return per page.

10
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Fetch All

When true, automatically fetches all pages of results using pagination.

false
Table ID

The ID or name of the table to list rows from.

{12B25C6E-59A4-4316-BE2E-325B2C8EDD50}
Workbook ID

The ID of the workbook that contains the worksheet to list rows from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to list rows from.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "value": [
      {
        "index": 99,
        "values": "values-value"
      }
    ]
  }
}

List Tables​

Retrieve a list of tables from a worksheet. | key: listTables

InputNotesExample
Expand

A comma-separated list of related resources to expand and include in the response.

members
Filter

An OData filter expression to narrow down results. For example: startswith(givenName,'J').

startswith(givenName,'J')
Format

The media format for the response. For example: json.

json
Order By

An OData orderBy expression to sort results. For example: displayName desc.

displayName desc
Search

A search string to filter results by matching against indexed properties.

pizza
Select

A comma-separated list of properties to include in the response. Reduces payload size.

givenName,surname
Skip

Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results.

10
Skip Token

Retrieves the next page of results from result sets that span multiple pages.

X%274453707402000100000017...
Top

The maximum number of results to return per page.

10
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Fetch All

When true, automatically fetches all pages of results using pagination.

false
Workbook ID

The ID of the workbook that contains the worksheet to list tables from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to list tables from.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "value": [
      {
        "id": "99",
        "name": "name-value",
        "showHeaders": true,
        "showTotals": true,
        "style": "style-value"
      }
    ]
  }
}

List Workbooks​

Returns a collection of workbooks from either a OneDrive or SharePoint site. | key: listWorkbooks

InputNotesExample
Expand

A comma-separated list of related resources to expand and include in the response.

members
Order By

An OData orderBy expression to sort results. For example: displayName desc.

displayName desc
Select

A comma-separated list of properties to include in the response. Reduces payload size.

givenName,surname
Skip Token

Retrieves the next page of results from result sets that span multiple pages.

X%274453707402000100000017...
Top

The maximum number of results to return per page.

10
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from. Use this or Path.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Fetch All

When true, automatically fetches all pages of results using pagination.

false
List or Item ID

The SharePoint list ID or OneDrive item ID used to scope the workbook search.

01J363WTN6Y2GOVW7725BZO354PWSELRRZ
Path

The path to the file or folder within the drive. Use this or Drive or Site ID.

/drive/root:/folder/file.xlsx

{
  "data": {
    "value": [
      {
        "@microsoft.graph.downloadUrl": "https://example.sharepoint.com/personal/user_example_onmicrosoft_com/_layouts/15/download.aspx?UniqueId=11111111-1111-1111-1111-111111111111&Translate=false&tempauth=EXAMPLETOKEN&ApiVersion=2.0",
        "createdBy": {
          "user": {
            "email": "user@example.onmicrosoft.com",
            "id": "00000000-0000-0000-0000-000000000000",
            "displayName": "Example User"
          }
        },
        "createdDateTime": "2025-07-03T19:12:11Z",
        "eTag": "\"{11111111-1111-1111-1111-111111111111},1\"",
        "id": "01ABCDEF123456XYZ",
        "lastModifiedBy": {
          "user": {
            "email": "user@example.onmicrosoft.com",
            "id": "00000000-0000-0000-0000-000000000000",
            "displayName": "Example User"
          }
        },
        "lastModifiedDateTime": "2025-07-03T19:24:55Z",
        "name": "Workbook.xlsx",
        "parentReference": {
          "driveType": "business",
          "driveId": "b!exampleDriveId123456789",
          "id": "01PARENTITEM123456XYZ",
          "name": "ExampleFolder",
          "path": "/drives/b!exampleDriveId123456789/root:/ExampleFolder",
          "siteId": "00000000-0000-0000-0000-000000000000"
        },
        "webUrl": "https://example.sharepoint.com/personal/user_example_onmicrosoft_com/_layouts/15/Doc.aspx?sourcedoc=%7B11111111-1111-1111-1111-111111111111%7D&file=Workbook.xlsx&action=default&mobileredirect=true",
        "cTag": "\"c:{11111111-1111-1111-1111-111111111111},1\"",
        "file": {
          "hashes": {
            "quickXorHash": "EXAMPLEHASH1234567890=="
          },
          "mimeType": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
        },
        "fileSystemInfo": {
          "createdDateTime": "2025-07-03T19:12:11Z",
          "lastModifiedDateTime": "2025-07-03T19:24:55Z"
        },
        "shared": {
          "scope": "users"
        },
        "size": 6727
      }
    ]
  }
}

List Worksheets​

Retrieve a list of worksheet objects. | key: listWorksheets

InputNotesExample
Expand

A comma-separated list of related resources to expand and include in the response.

members
Filter

An OData filter expression to narrow down results. For example: startswith(givenName,'J').

startswith(givenName,'J')
Format

The media format for the response. For example: json.

json
Order By

An OData orderBy expression to sort results. For example: displayName desc.

displayName desc
Search

A search string to filter results by matching against indexed properties.

pizza
Select

A comma-separated list of properties to include in the response. Reduces payload size.

givenName,surname
Skip

Indexes into a result set. Also used by some APIs to implement paging and can be used together with $top to manually page results.

10
Skip Token

Retrieves the next page of results from result sets that span multiple pages.

X%274453707402000100000017...
Top

The maximum number of results to return per page.

10
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Fetch All

When true, automatically fetches all pages of results using pagination.

false
Workbook ID

The ID of the workbook to retrieve.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ

{
  "data": {
    "value": [
      {
        "id": "id-value",
        "position": 99,
        "name": "name-value",
        "visibility": "visibility-value"
      }
    ]
  }
}

Raw Request​

Send raw HTTP request to Microsoft Excel API. | key: rawRequest

InputNotesExample
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.

false
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input the path only (/me/drive), The base URL is already included (https://graph.microsoft.com/v1.0). For example, to connect to https://graph.microsoft.com/v1.0/me/drive, only /me/drive is entered in this field.

/me/drive
Use Exponential Backoff

Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.

false

Read from Buffer​

Parses an xlsx file from a buffer and outputs an array of worksheets. | key: parseBuffer

InputNotesExample
File

A spreadsheet file or buffer to be parsed into array values.

Read from URL​

Parses an xlsx file from a URL endpoint and outputs an array of worksheets. | key: parse

InputNotesExample
File URL

The URL of the xlsx file to download and parse.

https://example.com/file.xlsx

Update Cell Range​

Update the properties of a range object. | key: updateCellRange

InputNotesExample
Address

The address of the range to update.

A1:B2
Column Hidden

When true, all columns in the current range are hidden.

false
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Formulas

Represents the formula in A1-style notation.

Formulas Local

Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English '=SUM(A1, 1.5)' formula would become '=SUMME(A1; 1,5)' in German.

Formulas R1C1

Represents the formula in R1C1-style notation.

Number Format

Represents Excel's number format code for the given cell.

Row Hidden

When true, all rows in the current range are hidden.

false
Values

Represents the raw values of the specified range. The data returned could be of type string, number, or a Boolean. Cell that contains an error returns the error string.

Workbook ID

The ID of the workbook that contains the worksheet to update cells from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to update cells from.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "address": "address-value",
    "addressLocal": "addressLocal-value",
    "cellCount": 99,
    "columnCount": 99,
    "columnIndex": 99,
    "valueTypes": "valueTypes-value"
  }
}

Update Column​

Updates a column object from a worksheet table. | key: updateColumn

InputNotesExample
Column ID

The id or name of the column to update.

1
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Table ID

The ID or name of the table to update the column from.

{12B25C6E-59A4-4316-BE2E-325B2C8EDD50}
Values

Represents the raw values of the specified range.

Workbook ID

The ID of the workbook that contains the worksheet to update the column from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to update the column from.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "values": [
      [
        "Column1"
      ],
      [
        "Test"
      ]
    ],
    "id": "1",
    "index": 0,
    "name": "Column1"
  }
}

Update Table​

Updates a table object from a worksheet. | key: updateTable

InputNotesExample
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Name

The display name of the table within the worksheet.

Table1
Show Headers

When true, the header row of the table is visible.

false
Show Totals

When true, the totals row of the table is visible.

false
Style

The Excel table style to apply. Controls visual formatting such as banding and header colors.

Table ID

The ID or name of the table to update.

{12B25C6E-59A4-4316-BE2E-325B2C8EDD50}
Workbook ID

The ID of the workbook that contains the worksheet to update the table from.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID or name of the worksheet to update the table from.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "id": "99",
    "name": "name-value",
    "showHeaders": true,
    "showTotals": true,
    "style": "style-value"
  }
}

Update Worksheet​

Updates a worksheet object from a workbook. | key: updateWorksheet

InputNotesExample
Connection

The Microsoft Excel connection to use. OneDrive and SharePoint connections are supported.

Drive or Site ID

The ID of the OneDrive or SharePoint site to list workbooks from.

b!WumF-zsD8ku93Y0QqhKM9jVTjPefo6RGrpVCkPpe547Qrf38sox_TYIFuj9sqJhv
Worksheet Name

The new display name of the worksheet.

Sheet1
Position

The zero-based position of the worksheet within the workbook.

0
Worksheet Visibility

The visibility state of the worksheet. Visible worksheets appear in the tab bar. Hidden worksheets can be unhidden from the UI. VeryHidden worksheets require code to unhide.

Workbook ID

The ID of the workbook that contains the worksheet to update.

02J363WTJPABCDEFGTIRHYMKT7BX7JJZXQ
Worksheet ID

The ID of the worksheet to update.

{00000000-0001-0000-0000-000000000000}

{
  "data": {
    "id": "id-value",
    "position": 99,
    "name": "name-value",
    "visibility": "visibility-value"
  }
}

Changelog​

2026-02-24​

Added support for OneDrive and SharePoint connections, enabling workbook access from shared drives and sites

2025-07-10​

  • Added inline data sources for selecting columns, tables, workbooks, worksheets, and drives or sites to enhance data selection capabilities

2025-07-04​

  • Added drive name labels for better readability in the user interface