Welcome to Sheet2DB, your go-to tool for transforming your Google Spreadsheet into a powerful JSON API! This documentation is your one-stop guide to mastering the Sheet2DB API. Got questions? No worries, just reach out to us anytime on support@sheet2db.com. We're here to help!
\nSign Up on Registration Page
\nSheet2DB utilizes the first row of your spreadsheet as a reference to structure the data below it. The format defined in the initial row serves as the blueprint for the data in subsequent rows, so it's important to ensure that it accurately represents your data structure.
\nThere are no strict limitations on the types of data you can include in the rows following the first one. Whether you have numerical values, text, dates, or even empty cells, Sheet2DB will handle them seamlessly.
\n![](\"https://sheet2db.io/spreadsheet.png\")
\n\nTo safeguard your APIs, it's advisable to grant the minimum necessary permissions required for your application to function effectively. For instance, if your intention is to use the API for data collection through a form, consider assigning only the Update permission. By doing so, even if someone discovers your endpoint, they won't have the capability to view your data.
\nFollowing are different permissions we support
\nRead : Grants the ability to view and retrieve data from a sheet. Users with this permission can access the data but cannot modify it in any way.
\nApply Filters: Allows users to apply filters on the data. Useful for narrowing down large datasets based on specific conditions without altering the actual data.
\nInsert: Enables users to add new rows to the sheet. This includes submitting new data entries through forms, APIs, or the dashboard UI.
\nUpdate: Allows users to modify existing rows in the sheet. They can change values in one or more columns for a given record.
\nDelete: Grants permission to permanently delete rows from the sheet. This action removes the data and cannot be undone unless backups or versioning are enabled.
\nClear: Allows users to clear all data from a sheet without deleting the sheet itself. The structure (columns and headers) remains intact, but the content is wiped.
\nAdd Sheet: Enables users to create new sheets within the current spreadsheet.
\nDelete Sheet: Grants permission to permanently delete an entire sheet within a spreadsheet and all of its data
\nAccessing an unauthorized endpoint will result in a 403 Forbidden error.\"
\nSheet2DB Supports 3 types for Authentication methods to safeguard access to your spreadsheet / database.
\nBasic Authentication
\nBearer Token
\nJWT Authentication
\nWith Basic Authentication, you use username and password to authenticate your HTTP requests. You can enter username and password of your choice.
\nWith Bearer Token, you can pass a custom token as Authorization Header to authenticate yourself
Using JWT Authentication, we provide you the flexibility to sign a token with your preferred encryption key. You may securely share the verification key with us to confirm that the token was indeed signed by you, ensuring access to your database.
\nSupported Algorithms
\nHS256
HS384
HS512
RS256
RS384
RS512
This endpoint allows you to retrieve content from a specific sheet in your spreadsheet. You can refine the data using query parameters, including filtering, pagination, sorting, and column selection.
\n","urlObject":{"path":["v1","data","77a54611-b6d2-414f-86b0-a9c7d327d6ed","Staff Data"],"host":["https://api.sheet2db.io"],"query":[{"disabled":true,"description":{"content":"Specifies the maximum number of rows to return. This helps control the size of the result set.
\n","type":"text/plain"},"key":"limit","value":"10"},{"disabled":true,"description":{"content":"Determines the starting point for fetching results, allowing you to skip a specified number of initial records. Useful for pagination.
\n","type":"text/plain"},"key":"offset","value":"10"},{"disabled":true,"description":{"content":"Apply filters to refine the data returned.
\n","type":"text/plain"},"key":"filter","value":"Id:eq:1562"},{"disabled":true,"description":{"content":"Specifies the format in which the data is returned: rows,columns,matrix
\n","type":"text/plain"},"key":"format","value":"rows"},{"disabled":true,"description":{"content":"The name of the column you want to sort the data by.
\n","type":"text/plain"},"key":"sortColumn","value":"Age"},{"disabled":true,"description":{"content":"Defines the sorting order
\n","type":"text/plain"},"key":"sortDirection","value":"desc"},{"disabled":true,"description":{"content":"Specify the columns you want to include or exclude from the response.
\n","type":"text/plain"},"key":"columns","value":"First Name,Last Name"}],"variable":[]}},"response":[],"_postman_id":"bad39ffe-7453-4984-a72a-77c4756e5080"},{"name":"Insert Rows","id":"b868f044-2213-4435-b4b7-7e31e6cccc36","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\":[\n {\n \"Id\":\"1000\",\n \"First Name\":\"John\",\n \"Last Name\":\"Doe\",\n \"Gender\":\"Male\",\n \"Country\":\"United States\",\n \"Age\":\"24\",\n \"Date\":\"21/08/2025\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sheet2db.io/v1/data/77a54611-b6d2-414f-86b0-a9c7d327d6ed/Staff Data","description":"This endpoint allows you to insert data into a specific sheet in your spreadsheet. You need to provide an array of objects where each object represents a row to be added to the sheet.
\n","urlObject":{"path":["v1","data","77a54611-b6d2-414f-86b0-a9c7d327d6ed","Staff Data"],"host":["https://api.sheet2db.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"b868f044-2213-4435-b4b7-7e31e6cccc36"},{"name":"Update using Filter","id":"e70382c2-1d59-42d3-90d2-5e1ad6ad7815","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"type\":\"filter\",\n \"filter\":\"Id:eq:1000\",\n \"data\":{\n \"First Name\":\"JohnI\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sheet2db.io/v1/data/77a54611-b6d2-414f-86b0-a9c7d327d6ed/Staff Data","description":"This endpoint allows you to update existing rows in a specific sheet of your spreadsheet. You can either update rows based on their index or apply a filter to update matching rows.
\nTo update using a filter, specify a filter expression that matches the rows you want to update.
\n","urlObject":{"path":["v1","data","77a54611-b6d2-414f-86b0-a9c7d327d6ed","Staff Data"],"host":["https://api.sheet2db.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"e70382c2-1d59-42d3-90d2-5e1ad6ad7815"},{"name":"Update using Row Number","id":"51136326-234f-4d64-a3f5-b2d6ecb02112","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"type\":\"row\",\n \"row\":\"11\",\n \"data\":{\n \"First Name\":\"JohnII\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sheet2db.io/v1/data/77a54611-b6d2-414f-86b0-a9c7d327d6ed/Staff Data","description":"This endpoint allows you to update existing rows in a specific sheet of your spreadsheet. You can either update rows based on their index or apply a filter to update matching rows.
\nTo update by row index, provide the row number.
\n","urlObject":{"path":["v1","data","77a54611-b6d2-414f-86b0-a9c7d327d6ed","Staff Data"],"host":["https://api.sheet2db.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"51136326-234f-4d64-a3f5-b2d6ecb02112"},{"name":"Delete using Filter","id":"3c90620d-920c-4f4d-a622-03e3a3ce8f54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"type\":\"filter\",\n \"filter\":\"Id:eq:1000\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sheet2db.io/v1/data/77a54611-b6d2-414f-86b0-a9c7d327d6ed/Staff Data","description":"This endpoint allows you to delete rows from a specific sheet in your spreadsheet. You can delete by row index or apply a filter to delete matching rows.
\nTo delete using a filter, specify a filter expression that matches the rows you want to delete.
\n","urlObject":{"path":["v1","data","77a54611-b6d2-414f-86b0-a9c7d327d6ed","Staff Data"],"host":["https://api.sheet2db.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"3c90620d-920c-4f4d-a622-03e3a3ce8f54"},{"name":"Delete using Row Number","id":"b041b750-2c1d-437d-8e61-6d8f3d827112","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"type\":\"filter\",\n \"row\":11\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sheet2db.io/v1/data/77a54611-b6d2-414f-86b0-a9c7d327d6ed/Staff Data","description":"This endpoint allows you to delete rows from a specific sheet in your spreadsheet. You can delete by row index or apply a filter to delete matching rows.
\nTo delete by row index, provide the row number.
\n","urlObject":{"path":["v1","data","77a54611-b6d2-414f-86b0-a9c7d327d6ed","Staff Data"],"host":["https://api.sheet2db.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"b041b750-2c1d-437d-8e61-6d8f3d827112"},{"name":"Add New Sheet","id":"7f3482e3-d6a4-4212-83b7-61a728362673","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Transactions\",\n \"firstRow\": [\n \"id\",\n \"transaction_id\",\n \"amount\",\n \"source\",\n \"destination\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.sheet2db.io/v1/data/77a54611-b6d2-414f-86b0-a9c7d327d6ed/sheet","description":"This endpoint allows you to create a new sheet (tab) within a given spreadsheet. You can specify the name of the sheet and the first row (which typically contains column headers).
\nUse the name field to define the sheet's name, and the firstRow field to set the column headers for the new sheet.
\n","urlObject":{"path":["v1","data","77a54611-b6d2-414f-86b0-a9c7d327d6ed","sheet"],"host":["https://api.sheet2db.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"7f3482e3-d6a4-4212-83b7-61a728362673"},{"name":"Delete Sheet","id":"eff3f7bb-34e7-4164-9acb-69b2eb319af5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.sheet2db.io/v1/data/77a54611-b6d2-414f-86b0-a9c7d327d6ed/sheet/Staff Data","description":"This endpoint allows you to delete rows from a specified sheet within a spreadsheet. You can delete rows by providing either a row index or a filter expression.
\nUse the type parameter to specify whether you want to delete a row by index or using a filter. If type is set to 'row', provide the row parameter. If type is set to 'filter', provide the filter parameter.
\n","urlObject":{"path":["v1","data","77a54611-b6d2-414f-86b0-a9c7d327d6ed","sheet","Staff Data"],"host":["https://api.sheet2db.io"],"query":[],"variable":[]}},"response":[],"_postman_id":"eff3f7bb-34e7-4164-9acb-69b2eb319af5"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"070a0370-d308-41b6-b468-cba52c085052"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"5ed4b0b4-58fc-4e1e-9016-cbddb2e704f3"}}],"variable":[{"key":"BASE_URL","value":"https://api.sheet2db.io","type":"default"},{"key":"API_ID","value":"77a54611-b6d2-414f-86b0-a9c7d327d6ed","type":"default"},{"key":"sheet","value":"Staff Data","type":"string"}]}