{"service":"bssheets-api","name":"BS Sheets","description":"The BSafe Group spreadsheet: documents, sheets, formulas, sharing and comments","base_url":"https://sheets-api.bsafegroup.be","client":"https://sheets.bsafegroup.be","api":"/api","health":"/health","endpoint_count":26,"endpoints":[{"group":"meta","method":"GET","path":"/","auth":"none","summary":"This document: what the service is and every route it serves"},{"group":"meta","method":"GET","path":"/health","auth":"none","summary":"Whether the service is up and can reach its database"},{"group":"meta","method":"OPTIONS","path":"/*","auth":"none","summary":"The CORS preflight, answered on every path"},{"group":"auth","method":"POST","path":"/auth/register","auth":"none","summary":"Open an account and start a session"},{"group":"auth","method":"POST","path":"/auth/login","auth":"none","summary":"Start a session with an email and a password"},{"group":"auth","method":"POST","path":"/auth/refresh","auth":"refresh","summary":"Swap a refresh token for a fresh access token"},{"group":"account","method":"GET","path":"/api/me","auth":"access","summary":"The signed in account and its preferences"},{"group":"account","method":"PUT","path":"/api/me","auth":"access","summary":"Change the display name"},{"group":"account","method":"PUT","path":"/api/me/preferences","auth":"access","summary":"Change the language, theme, currency and zoom"},{"group":"templates","method":"GET","path":"/api/templates","auth":"none","summary":"The starter templates, named in the reader's language"},{"group":"workbooks","method":"GET","path":"/api/workbooks","auth":"access","summary":"Every file this account may open, most recently opened first"},{"group":"workbooks","method":"POST","path":"/api/workbooks","auth":"access","summary":"Create a file, empty or from a template"},{"group":"workbooks","method":"POST","path":"/api/workbooks/bin/empty","auth":"access","summary":"Delete everything in the bin"},{"group":"workbooks","method":"DELETE","path":"/api/workbooks/:id","auth":"access","summary":"Delete a file, or give up your own access to a shared one"},{"group":"workbooks","method":"POST","path":"/api/workbooks/:id/copy","auth":"access","summary":"Duplicate a file, with its sheets, charts and named ranges"},{"group":"workbooks","method":"PATCH","path":"/api/workbooks/:id/name","auth":"access","summary":"Rename a file"},{"group":"workbooks","method":"PATCH","path":"/api/workbooks/:id/starred","auth":"access","summary":"Star or unstar a file, for this account only"},{"group":"workbooks","method":"PATCH","path":"/api/workbooks/:id/trashed","auth":"access","summary":"Move a file to the bin or take it back out"},{"group":"documents","method":"GET","path":"/api/workbooks/:id","auth":"access","summary":"One whole document: sheets, cells, charts, named ranges, comments"},{"group":"documents","method":"PUT","path":"/api/workbooks/:id","auth":"access","summary":"Save one whole document, refused if it was built on an older version"},{"group":"collaboration","method":"POST","path":"/api/workbooks/:id/share","auth":"access","summary":"Give somebody access, or change the access they have"},{"group":"collaboration","method":"DELETE","path":"/api/workbooks/:id/share/:userId","auth":"access","summary":"Take somebody's access away"},{"group":"collaboration","method":"POST","path":"/api/workbooks/:id/comments","auth":"access","summary":"Comment on a cell"},{"group":"collaboration","method":"POST","path":"/api/workbooks/:id/comments/:cid/replies","auth":"access","summary":"Reply to a comment"},{"group":"collaboration","method":"PATCH","path":"/api/workbooks/:id/comments/:cid/resolved","auth":"access","summary":"Resolve a comment or reopen it"},{"group":"collaboration","method":"DELETE","path":"/api/workbooks/:id/comments/:cid","auth":"access","summary":"Remove a comment"}]}