excel.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.
New to Corsair? See API access, authentication, and error handling.
Charts
add
charts.add
Add a chart from a cell range
Risk: write
Output
delete
charts.delete
Delete a chart
Risk: destructive
Output:
undefined \| null \| object
Output full type
Output full type
get
charts.get
Get one chart by name or id
Risk: read
Output
list
charts.list
List charts on a worksheet
Risk: read
Output
value full type
value full type
setData
charts.setData
Point a chart at a different cell range
Risk: write
Output:
undefined \| null \| object
Output full type
Output full type
update
charts.update
Rename a chart or move and resize it
Risk: write
Output
Comments
get
comments.get
Get one comment
Risk: read
Output
list
comments.list
List comments in a workbook
Risk: read
Output
value full type
value full type
listReplies
comments.listReplies
List replies on a comment
Risk: read
Output
value full type
value full type
reply
comments.reply
Reply to a comment
Risk: write
Output
Files
create
files.create
Upload a blank .xlsx workbook to OneDrive or SharePoint
Risk: write
Output
find
files.find
Search OneDrive or SharePoint for .xlsx files
Risk: read
Output
value full type
value full type
Functions
calculate
functions.calculate
Run an Excel worksheet function such as SUM or VLOOKUP
Risk: read
args full type
args full type
Names
add
names.add
Define a named range
Risk: write
Output
value full type
value full type
get
names.get
Get one named range
Risk: read
Output
value full type
value full type
list
names.list
List named ranges in a workbook or worksheet
Risk: read
Output
value full type
value full type
range
names.range
Read the cells a named range points at
Risk: read
Output
update
names.update
Change a named range comment or visibility
Risk: write
Output
value full type
value full type
Ranges
clear
ranges.clear
Clear values or formatting in a range
Risk: write
Output:
undefined \| null \| object
Output full type
Output full type
get
ranges.get
Read a cell range
Risk: read
Output
update
ranges.update
Write values, formulas, or number formats into a range
Risk: write
Output
usedRange
ranges.usedRange
Read the used range of a worksheet
Risk: read
Output
Sessions
close
sessions.close
Close an Excel workbook session
Risk: write
Output:
undefined \| null \| object
Output full type
Output full type
create
sessions.create
Open a persistent or temporary Excel workbook session
Risk: write
Output
refresh
sessions.refresh
Keep an Excel workbook session alive
Risk: write
Output:
undefined \| null \| object
Output full type
Output full type
Tables
add
tables.add
Create a table from a range
Risk: write
Output
addColumn
tables.addColumn
Insert a column into a table
Risk: write
Output
addRows
tables.addRows
Insert one or more rows into a table
Risk: write
Output
delete
tables.delete
Delete a table
Risk: destructive
Output:
undefined \| null \| object
Output full type
Output full type
deleteColumn
tables.deleteColumn
Delete a table column
Risk: destructive
Output:
undefined \| null \| object
Output full type
Output full type
deleteRow
tables.deleteRow
Delete a table row by index
Risk: destructive
Output:
undefined \| null \| object
Output full type
Output full type
get
tables.get
Get one table by name or id
Risk: read
Output
list
tables.list
List tables in a workbook or worksheet
Risk: read
Output
value full type
value full type
listColumns
tables.listColumns
List columns in a table
Risk: read
Output
value full type
value full type
listRows
tables.listRows
List rows in a table
Risk: read
Output
value full type
value full type
update
tables.update
Rename a table or change its header, total, or style
Risk: write
Output
Worksheets
add
worksheets.add
Add a worksheet
Risk: write
Output
delete
worksheets.delete
Delete a worksheet
Risk: destructive
Output:
undefined \| null \| object
Output full type
Output full type
get
worksheets.get
Get one worksheet by name or id
Risk: read
Output
list
worksheets.list
List worksheets in a workbook
Risk: read
Output
value full type
value full type
update
worksheets.update
Rename a worksheet or change its position
Risk: write
Output