Skip to main content
Every 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
Input Output

delete

charts.delete Delete a chart Risk: destructive
Input Output: undefined \| null \| object

get

charts.get Get one chart by name or id Risk: read
Input Output

list

charts.list List charts on a worksheet Risk: read
Input Output

setData

charts.setData Point a chart at a different cell range Risk: write
Input Output: undefined \| null \| object

update

charts.update Rename a chart or move and resize it Risk: write
Input Output

Comments

get

comments.get Get one comment Risk: read
Input Output

list

comments.list List comments in a workbook Risk: read
Input Output

listReplies

comments.listReplies List replies on a comment Risk: read
Input Output

reply

comments.reply Reply to a comment Risk: write
Input Output

Files

create

files.create Upload a blank .xlsx workbook to OneDrive or SharePoint Risk: write
Input Output

find

files.find Search OneDrive or SharePoint for .xlsx files Risk: read
Input Output

Functions

calculate

functions.calculate Run an Excel worksheet function such as SUM or VLOOKUP Risk: read
Input
Output

Names

add

names.add Define a named range Risk: write
Input Output

get

names.get Get one named range Risk: read
Input Output

list

names.list List named ranges in a workbook or worksheet Risk: read
Input Output

range

names.range Read the cells a named range points at Risk: read
Input Output

update

names.update Change a named range comment or visibility Risk: write
Input Output

Ranges

clear

ranges.clear Clear values or formatting in a range Risk: write
Input Output: undefined \| null \| object

get

ranges.get Read a cell range Risk: read
Input Output

update

ranges.update Write values, formulas, or number formats into a range Risk: write
Input Output

usedRange

ranges.usedRange Read the used range of a worksheet Risk: read
Input Output

Sessions

close

sessions.close Close an Excel workbook session Risk: write
Input Output: undefined \| null \| object

create

sessions.create Open a persistent or temporary Excel workbook session Risk: write
Input Output

refresh

sessions.refresh Keep an Excel workbook session alive Risk: write
Input Output: undefined \| null \| object

Tables

add

tables.add Create a table from a range Risk: write
Input Output

addColumn

tables.addColumn Insert a column into a table Risk: write
Input Output

addRows

tables.addRows Insert one or more rows into a table Risk: write
Input Output

delete

tables.delete Delete a table Risk: destructive
Input Output: undefined \| null \| object

deleteColumn

tables.deleteColumn Delete a table column Risk: destructive
Input Output: undefined \| null \| object

deleteRow

tables.deleteRow Delete a table row by index Risk: destructive
Input Output: undefined \| null \| object

get

tables.get Get one table by name or id Risk: read
Input Output

list

tables.list List tables in a workbook or worksheet Risk: read
Input Output

listColumns

tables.listColumns List columns in a table Risk: read
Input Output

listRows

tables.listRows List rows in a table Risk: read
Input Output

update

tables.update Rename a table or change its header, total, or style Risk: write
Input Output

Worksheets

add

worksheets.add Add a worksheet Risk: write
Input Output

delete

worksheets.delete Delete a worksheet Risk: destructive
Input Output: undefined \| null \| object

get

worksheets.get Get one worksheet by name or id Risk: read
Input Output

list

worksheets.list List worksheets in a workbook Risk: read
Input Output

update

worksheets.update Rename a worksheet or change its position Risk: write
Input Output