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.

Get multiple rows

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.

Request Body

Name	Type	Description
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.

200

Get single row

POST https://script.google.com/macros/s/SCRIPT_ID/exec/

Request Body

Name	Type	Description
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.

200

Insert row

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: 'POST', sheet: 'users', payload: { Name": "Adam" } },
    { method: 'POST', sheet: 'users', payload: { Name": "John" } },
    { method: 'POST', sheet: 'users', payload: { Name": "Alex" } }
]

Request Body

Name	Type	Description
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.

200

Update row

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: 'PUT', sheet: 'users', payload: { id: 2, Name": "Adam" } },
    { method: 'PUT', sheet: 'users', payload: { id: 10, Name": "John" } },
    { method: 'PUT', sheet: 'users', payload: { id: 5, Name": "Alex" } }
]

Request Body

Name	Type	Description
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.

200

Remove row

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: 'DELETE', sheet: 'users', id: 2 },
    { method: 'DELETE', sheet: 'users', id: 10 },
    { method: 'DELETE', sheet: 'users', id: 5 }
]

Request Body

Name	Type	Description
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.

200