API/Endpoints

API Endpoints

Complete reference of available HTTP methods to interact with your spreadsheet. Replace [sheetId] with your project ID.

GETList Records

/api/sheets/[sheetId]

Returns all records from the spreadsheet in JSON array format.

Parameters (Query):

  • limit (optional): Limits the number of results.
  • offset (optional): Pagination.

GETGet Record

/api/sheets/[sheetId]?id=123

Returns a single record where the id column matches the value.

POSTCreate Record

/api/sheets/[sheetId]

Adds a new row to the spreadsheet. The request body must be a JSON object with keys corresponding to the columns.

{
  "name": "New Customer",
  "email": "customer@example.com"
}

PUTUpdate Record

/api/sheets/[sheetId]?id=123

Updates an existing row based on the ID.

DELETEDelete Record

/api/sheets/[sheetId]?id=123

Removes the corresponding row from the spreadsheet.