API Reference
Last updated
Last updated
Check out to see how to use SpreadAPI from a browser application.
POST
https://script.google.com/macros/s/SCRIPT_ID/exec/
Return list of rows. Empty rows are skipped. Each row has an _id field which is equal to row number in Google Sheets.
method
string
GET
sheet
string
Sheet name, e.g. transactions or users
key
string
Authentication key. See page Setup -> authentication for details.
order
string
Order of results. Ascending by default. For descending use DESC.
start_id
number
ID of the first row to return. By default first row in the spreadsheet (or last row if order = DESC).
limit
number
Maximum number of rows in response. By default all rows are returned.
POST
https://script.google.com/macros/s/SCRIPT_ID/exec/
method
string
GET
sheet
string
Sheet name, e.g. transactions or users.
id
number
ID of row to get.
key
string
Authentication key. See page Setup -> authentication for details.
POST
https://script.google.com/macros/s/SCRIPT_ID/exec/
Adds a row to the end of sheet. To add multiple rows pass an array of objects e.g.:
method
string
POST
sheet
string
Sheet name, e.g. transactions or users.
key
string
Authentication key. See page Setup -> authentication for details.
payload
object
Object with new row content.
POST
https://script.google.com/macros/s/SCRIPT_ID/exec/
Update content of a single row. To update multiple rows pass an array of objects e.g.:
method
string
PUT
sheet
string
Sheet name, e.g. transactions or sheets.
id
string
ID of row to update.
key
string
Authentication key. See page Setup -> authentication for details.
payload
object
Object with the updated row content.
POST
https://script.google.com/macros/s/SCRIPT_ID/exec/
Clear a single row. Notice, that the row is not physically removed so that ids of the following rows don't change.
To remove multiple rows pass an array of objects e.g.:
method
string
DELETE
sheet
string
Sheet name, e.g. transations or users
id
number
ID ofrow to remove
key
string
Authentication key. See page Setup -> authentication for details.