Documentation Powered by Redocly

SheetRocks API (1.0.0)

Download OpenAPI specification:Download

Manipulate your spreadsheet from a RESTful API.

Appends cell array to end of sheet.

Appends cell array to end of sheet.

Request Body schema: application/json

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 ]

Responses

Request samples

Content type
application/json
{
  • "Cells": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

Exports the sheet as a CSV attachment.

Exports the sheet as a CSV attachment.

Responses

Creates a new sheet as part of the workbook.

Creates a new sheet as part of the workbook.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "sheetId": "string"
}

Gets cells from the worksheet.

Gets cells from the worksheet.

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Trashes the sheet and removes it from the workbook.

Trashes the sheet and removes it from the workbook.

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Sets the value of given cells. Will trigger recalculation.

Sets the value of given cells. Will trigger recalculation.

Request Body schema: application/json

The cell to set.

Array of objects[ items ]

Responses

Request samples

Content type
application/json
{
  • "Cells": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true
}

Gets page number for given row.

Gets page number for given row.

query Parameters
rowStart
number

The row to find the page it falls into.

Responses

Response samples

Content type
application/json
{
  • "Page": 0
}

Gets a variety of values required for initial render of a sheet.

Gets a variety of values required for initial render of a sheet.

Responses

Response samples

Content type
application/json
{
  • "Cells": [
    ],
  • "Settings": {
    },
  • "Filters": [
    ],
  • "Dropdowns": [
    ]
}

Deletes the contents of the cells in the specified range.

Deletes the contents of the cells in the specified range.

query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Gets the values of cells in the specified range.

Gets the values of cells in the specified range.

query Parameters
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.

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Updates the name of the sheet

Updates the name of the sheet

query Parameters
newName
string

The new name of the sheet.

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Searches the sheet for the provided string

Searches the sheet for the provided string. Executes a case-insensitive search with a maximum of 100 results.

query Parameters
searchString
string

The string to search the sheet for.

Responses

Response samples

Content type
application/json
{
  • "PageList": [
    ],
  • "LastPage": 0,
  • "LastPageIndex": 0,
  • "Total": 0,
  • "Data": { }
}

Navigates through the sheet according to certain rules (control + arrow key functionality).

Navigates through the sheet according to certain rules (control + arrow key functionality).

query Parameters
row
number

The row index of the sheet where you are navigating from.

col
number

The column index of the sheet where you are navigating from.

direction
string

The direction you are navigating (one of "up", "down", "left", or "right")

Responses

Response samples

Content type
application/json
{
  • "Row": 0,
  • "Col": 0
}

Undoes the trash operation for the workbook.

Undoes the trash operation for the workbook.

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Sets settings for the workbook.

Sets settings for the workbook.

Responses

Response samples

Content type
application/json
{
  • "theme": "string",
  • "timezone": "string"
}

Adds rows to the spreadsheet.

Adds rows to the spreadsheet.

query Parameters
insertAfter
integer

The index of the row to insert additional rows after.

insertRows
integer

The number of rows to add.

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Clears and removes the specified rows.

Clears and removes the specified rows.

query Parameters
deleteRowStart
integer

The index of the first row to delete.

deleteRowEnd
integer

The index of the last row to delete.

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Adds columns to the spreadsheet.

Adds columns to the spreadsheet.

query Parameters
insertAfter
integer

The index of the column to insert additional rows after.

insertColumns
integer

The number of columns to add.

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Clears and removes the specified columns.

Clears and removes the specified columns.

query Parameters
deleteColStart
integer

The index of the first row to delete.

deleteColEnd
integer

The index of the last row to delete.

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Clears the copied state for the requesting user.

Clears the copied state for the requesting user.

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Copies to clipboard

Copies to clipboard

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Returns currently copied content as a 2D array of strings

Returns currently copied content as a 2D array of strings

Request Body schema: application/json

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

Responses

Request samples

Content type
application/json
{
  • "StartRow": 0,
  • "StartCol": 0,
  • "EndRow": true,
  • "EndCol": true
}

Response samples

Content type
application/json
[
  • [
    ]
]

Pastes from clipboard

Pastes from clipboard

Request Body schema: application/json

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