Download OpenAPI specification:Download
Manipulate your spreadsheet from a RESTful API.
Appends cell array to end of sheet.
The cell data to append to the end of the sheet. Data is sent as strings and will be automatically parsed and typed server side.
Cells | Array of Array of strings[ items ] |
{- "Cells": [
- [
- "string"
]
]
}
{- "success": true
}
Sets the value of given cells. Will trigger recalculation.
The cell to set.
Array of objects[ items ] |
{- "Cells": [
- {
- "Row": 0,
- "Col": 0,
- "CellValue": "string"
}
]
}
{- "success": true
}
Gets a variety of values required for initial render of a sheet.
{- "Cells": [
- [
- {
- "Value": "string",
- "Formula": "string"
}
]
], - "Settings": {
- "Settings": {
- "ColWidths": { },
- "RowHeights": { }
}, - "Config": {
- "NRows": 0
}
}, - "Filters": [
- {
- "FilterType": "string",
- "Include": "string"
}
], - "Dropdowns": [
- { }
]
}
Deletes the contents of the cells in the specified range.
type | string Type of operation. If 'values' or not given, will delete values only. If 'formatting' will delete formatting. |
range | string The range of selected cells in A1 notation form. |
{- "success": true
}
Gets the values of cells in the specified range.
type | string Type of operation. If 'values' or not given, will delete values only. If 'formatting' will delete formatting. |
range | string The range of selected cells in A1 notation form. |
[- [
- "string"
]
]
Searches the sheet for the provided string. Executes a case-insensitive search with a maximum of 100 results.
searchString | string The string to search the sheet for. |
{- "PageList": [
- { }
], - "LastPage": 0,
- "LastPageIndex": 0,
- "Total": 0,
- "Data": { }
}
Returns currently copied content as a 2D array of strings
Data about what cells to copy
StartRow required | integer Row of starting location |
StartCol required | integer Column of starting location |
EndRow required | boolean Row of end location |
EndCol required | boolean Column of end location |
{- "StartRow": 0,
- "StartCol": 0,
- "EndRow": true,
- "EndCol": true
}
[- [
- "string"
]
]
Pastes from clipboard
Data about where to paste the clipboard and where user cut from.
DestRow required | integer Row of pasting location |
DestCol required | integer Column of pasting location |
IsCut required | boolean Specifies if original selection will be deleted |
ValuesOnly required | boolean If true only values will be pasted. |
CutFromSheetId | string Sheet ID that clipboard was copied from. |
CutRowStart | integer Start row of cut selection. |
CutRowEnd | integer End row of cut selection. |
CutColStart | integer Start column of cut selection. |
CutColEnd | integer End column of cut selection. |
CutColsOnly | boolean If true the cut selection is columns only. |
CutRowsOnly |