{"openapi":"3.0.0","info":{"description":"Spreadsheet application"},"servers":[{"description":"Spreadsheet application","url":"https://api.apirails.com/zohosheet"}],"paths":{"/api/v2/{resource_id}":{"post":{"tags":["Worksheet"],"parameters":[{"name":"resource_id","in":"path","description":"Resource Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/sheet/help/api/v2/#WORKSHEET-Delete-worksheet","api_endpoint":"https://{sheet_host}/api/v2/{resource_id}"},"summary":"Delete worksheet","description":"Delete worksheet","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"method":{"type":"string","description":"worksheet.delete"},"worksheet_id":{"type":"string","description":"Alternatively worksheet_id can be used instead of worksheet_name"},"worksheet_name":{"type":"string","description":"Name of the worksheet that needs to be deleted"}}},"example":{"method":"","worksheet_id":"","worksheet_name":""}}}}}},"/api/v2/utils":{"post":{"tags":["Utility APIs"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/sheet/help/api/v2/#UTILITY-Convert-Index-to-Range","api_endpoint":"https://{sheet_host}/api/v2/utils"},"summary":"Convert Index to Range","description":"used to convert start row, start column, end row, end column indexes respectively to a Range","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"method":{"type":"string","description":"range.address.get"},"end_column":{"type":"number","description":"End column index of the range"},"end_row":{"type":"number","description":"End row index of the range"},"start_column":{"type":"number","description":"Start column index of the range"},"start_row":{"type":"number","description":"Start row index of the range"}}},"example":{"method":"","end_column":"","end_row":"","start_column":"","start_row":""}}}}}},"/api/v2/workbooks":{"post":{"tags":["Workbook"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/sheet/help/api/v2/#WORKBOOK-List-all-workbooks","api_endpoint":"https://{sheet_host}/api/v2/workbooks"},"summary":"List all workbooks","description":"List all workbooks of the user","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"method":{"type":"string","description":"workbook.list"},"count":{"type":"number","description":"It denotes the number of resources in response"},"sort_option":{"type":"enum","description":"Supported options are 'recently_opened', 'recently_modified', 'recently_created', 'ascending', and 'descending'"},"start_index":{"type":"string","description":"This parameter can be used to get a few resources if there are too many"}}},"example":{"method":"","count":"","sort_option":"","start_index":""}}}}}},"/api/v2/templates":{"post":{"tags":["Workbook"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/sheet/help/api/v2/#WORKBOOK-List-all-templates","api_endpoint":"https://{sheet_host}/api/v2/templates"},"summary":"List all templates","description":"List all templates of the user","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"method":{"type":"list","description":"template.list"}}},"example":{"method":""}}}}}},"/api/v2/create":{"post":{"tags":["Workbook"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/sheet/help/api/v2/#WORKBOOK-Create-workbook","api_endpoint":"https://{sheet_host}/api/v2/create"},"summary":"Create workbook","description":"Create workbook used to add a new workbook","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"method":{"type":"string","description":"workbook.create"},"workbook_name":{"type":"string","description":"Name of the new workbook"}}},"example":{"method":"","workbook_name":""}}}}}},"/api/v2/createfromtemplate":{"post":{"tags":["Workbook"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/sheet/help/api/v2/#WORKBOOK-Create-workbook-from-template","api_endpoint":"https://{sheet_host}/api/v2/createfromtemplate"},"summary":"Create workbook from template","description":"Create a new workbook from a template","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"method":{"type":"string","description":"workbook.createfromtemplate"},"resource_id":{"type":"string","description":"The resource id of the template"},"workbook_name":{"type":"string","description":"Name of the new workbook"}}},"example":{"method":"","resource_id":"","workbook_name":""}}}}}},"/api/v2/upload":{"post":{"tags":["Workbook"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/sheet/help/api/v2/#WORKBOOK-Upload-workbook","api_endpoint":"https://{sheet_host}/api/v2/upload"},"summary":"Upload workbook","description":"Upload workbook","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"method":{"type":"string","description":"workbook.upload"},"date_format":{"type":"string","format":"binary","description":"Optional parameter and it is used only for CSV file type"},"delimiter":{"type":"string","format":"binary","description":"Optional parameter and it is used only for CSV file type"},"file":{"type":"string","format":"binary","description":"Local file that needs to be uploaded"},"file_url":{"type":"string","description":"If the user wants to upload file from a url this parameter can be used instead of file parameter"},"workbook_name":{"type":"string","description":"Name of the new workbook"}}},"example":{"method":"","date_format":"(binary)","delimiter":"(binary)","file":"(binary)","file_url":"","workbook_name":""}}}}}},"/api/v2/download/{resource_id}":{"post":{"tags":["Workbook"],"parameters":[{"name":"resource_id","in":"path","description":"Resource Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/sheet/help/api/v2/#WORKBOOK-Download-workbook","api_endpoint":"https://{sheet_host}/api/v2/download/{resource_id}"},"summary":"Download workbook","description":"Used to download an existing workbook","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"method":{"type":"string","description":"workbook.upload"},"format":{"type":"enum","description":"Supported formats are xls, xlsx, csv, tsv, ods and pdf","enum":["xls","xlsx","csv","tsv","ods","pdf"]},"page_settings":{"type":"string","format":"binary","description":"This is an optional parameter and can be used only with PDF file"},"range":{"type":"string","format":"binary","description":"A particular range can also be downloaded in CSV, TSV and PDF file format"},"workbook_name":{"type":"string","description":"Name of the new workbook"},"worksheet_name":{"type":"string","description":"Name of the worksheet when a particular sheet needs to be downloaded"}}},"example":{"method":"workbook.download","format":"pdf","page_settings":{"add_chart":true,"margin_left":0.5,"margin_right":0.5,"page_order":"overDown","print_type":"SHEET"},"range":"A1:E8","workbook_name":"","worksheet_name":"sheet1"}}}}}},"/api/v2/insertimages":{"post":{"tags":["Workbook"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/sheet/help/api/v2/#WORKBOOK-Insert-images","api_endpoint":"https://{sheet_host}/api/v2/insertimages"},"summary":"Insert images","description":"Insert images into a workbook","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"method":{"type":"string","description":"workbook.images.insert"},"image_json":{"type":"array","description":"JSON Array","items":{"type":"string"}},"imagefiles":{"type":"string","format":"binary","description":"Local image files that needs to be uploaded"},"resource_id":{"type":"string","description":"The resource id of the workbook where the images needs to be inserted"}}},"example":{"method":"","image_json":[],"imagefiles":"(binary)","resource_id":""}}}}}},"/api/v2/copy":{"post":{"tags":["Workbook"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/sheet/help/api/v2/#WORKBOOK-Copy-workbook","api_endpoint":"https://{sheet_host}/api/v2/copy"},"summary":"Copy workbook","description":"Used to make a new copy of an existing workbook","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"method":{"type":"string","description":"workbook.copy"},"resource_id":{"type":"string","description":"The resource id of the workbook that needs to be copied"},"workbook_name":{"type":"string","description":"Name of the copied workbook"}}},"example":{"method":"","resource_id":"","workbook_name":""}}}}}},"/api/v2/share":{"post":{"tags":["Workbook"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/sheet/help/api/v2/#WORKBOOK-Share-workbook","api_endpoint":"https://{sheet_host}/api/v2/share"},"summary":"Share workbook","description":"Used to share a workbook with a user","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"method":{"type":"string","description":"workbook.share"},"resource_id":{"type":"string","description":"The resource id of the workbook that needs to be shared"},"share_json":{"type":"array","description":"JSON Array consisting of the user's email id and the access level with which the user will be able to view the shared workbook","items":{"type":"string"}}}},"example":{"method":"","resource_id":"","share_json":[]}}}}}},"/api/v2/trash":{"post":{"tags":["Workbook"],"parameters":[{"name":"resource_id","in":"path","description":"Resource Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/sheet/help/api/v2/#WORKBOOK-Create-version","api_endpoint":"https://{sheet_host}/api/v2/trash"},"summary":"Trash workbook","description":"Used to create a new version","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"method":{"type":"string","description":"workbook.version.create"},"version_description":{"type":"string","description":"Name of the new version"}}},"example":{"method":"","version_description":""}}}}}},"/api/v2/restore":{"post":{"tags":["Workbook"],"parameters":[{"name":"resource_id","in":"path","description":"Resource Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://www.zoho.com/sheet/help/api/v2/#WORKBOOK-Revert-version","api_endpoint":"https://{sheet_host}/api/v2/restore"},"summary":"Restore workbook","description":"Used to revert to an older version","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"method":{"type":"string","description":"workbook.version.revert"},"version_number":{"type":"number","description":"Version_number of the version to be reverted"}}},"example":{"method":"","version_number":""}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}