# Welcome

Welcome to SheetRest documentation! On this page, we'll give you a quick overview of what SheetRest is and how it works. If at any given point you have questions or need help, please don't hesitate to contact us.

SheetRest enables you to build a powerful REST API on top of your Spreadsheets. It allows you to query, update, create and delete rows in you spreadsheets as well as perform more advanced operations with data inside your sheets. SheetRest works with Google Spreadsheets, File uploads and custom spreadsheets created from scratch within SheetRest.

Let's say you have a spreadsheet with the following data inside Google Sheets:

Once you import this sheet into SheetRest, you will have a full REST API to manipulate with its content. All the changes propagate back to Google Spreadsheet which allows you to build even more automation. Let's have a look at some of the things you can do with this API.

You can query data from uploaded spreadsheet via GET endpoint. In order to get all the data from the spreadsheet, you can use the following request:

# Replace SHEET_ID with your sheet ID
curl -X GET \
  "https://sheetrest.com/api/v1/SHEET_ID"

Which will give you the following JSON:

[
  {
    "Name": "Bob",
    "Age": 30,
    "City": "New York"
  },
  {
    "Name": "Alice",
    "Age": 25,
    "City": "Los Angeles"
  },
  {
    "Name": "John",
    "Age": 40,
    "City": "Chicago"
  }
]

Adding new rows to the spreadsheet is as simple as sending a POST request to the simple endpoint:

curl -X POST \
  "https://sheetrest.com/api/v1/SHEET_ID" \
  -H 'Content-Type: application/json' \
  -d '{
    "Name": "Bob",
    "Age": 30,
    "City": "New York"
  }'

Which will add a new row to the spreadsheet.

Read more in dedicated PUT section.

You can update rows via PUT request to the your sheet endpoint:

curl -X PUT \
  "https://sheetrest.com/api/v1/SHEET_ID?_id=0" \
  -H 'Content-Type: application/json' \
  -d '{
    "Name": "Bob",
    "Age": 30,
    "City": "New York"
  }'

Which will update the first row in the spreadsheet.

Read more in dedicated DELETE section.

You can delete rows by sending DELETE request to the your sheet endpoint:

curl -X DELETE \
  "https://sheetrest.com/api/v1/SHEET_ID?_id=0"

Which will delete the first row in the spreadsheet.

Now that you have a quick overview of what SheetRest is and how it works, you can start building your first API. If you have any questions or need help, please don't hesitate to contact us.

Once you're ready to start building , you can start with importing your first sheet.