API Reference

SpreadAPI is maintained by the author of Roombelt - simple and reliable meeting room display system. If you want to support SpreadAPI consider trying Roombelt in your company!

Check out this live example to see how to use SpreadAPI from a browser application.

post
Get multiple rows

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.
Request
Response
Request
Body Parameters
method
required
string
GET
sheet
required
string
Sheet name, e.g. transactions or users
key
required
string
Authentication key. See page Setup -> authentication for details.
order
optional
string
Order of results. Ascending by default. For descending use DESC.
start_id
optional
number
ID of the first row to return. By default first row in the spreadsheet (or last row if order = DESC).
limit
optional
number
Maximum number of rows in response. By default all rows are returned.
Response
200: OK

post
Get single row

https://script.google.com/macros/s/SCRIPT_ID/exec/
Request
Response
Request
Body Parameters
method
required
string
GET
sheet
required
string
Sheet name, e.g. transactions or users.
id
required
number
ID of row to get.
key
required
string
Authentication key. See page Setup -> authentication for details.
Response
200: OK

post
Insert row

https://script.google.com/macros/s/SCRIPT_ID/exec/
Adds a row to the end of sheet.
Request
Response
Request
Body Parameters
method
required
string
POST
sheet
required
string
Sheet name, e.g. transactions or users.
key
required
string
Authentication key. See page Setup -> authentication for details.
payload
required
object
Object with new row content.
Response
200: OK

post
Update row

https://script.google.com/macros/s/SCRIPT_ID/exec/
Update content of a single row.
Request
Response
Request
Body Parameters
method
required
string
PUT
sheet
required
string
Sheet name, e.g. transactions or sheets.
id
required
string
ID of row to update.
key
required
string
Authentication key. See page Setup -> authentication for details.
payload
required
object
Object with the updated row content.
Response
200: OK

post
Remove row

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.
Request
Response
Request
Body Parameters
method
required
string
DELETE
sheet
required
string
Sheet name, e.g. transations or users
id
required
number
ID ofrow to remove
key
required
string
Authentication key. See page Setup -> authentication for details.
Response
200: OK