Zoho Sheet API Docs

The Zoho Sheet Web API allows client applications to manipulate the workbooks available in their Zoho Sheet account.
i.e through the API one can view,list,edit,save existing workbooks and add new ones to their account. A host of other useful operations will be available soon. This API provides an easy way to integrate Zoho services into your application.

The client request for performing an action and the corresponding Zoho Sheet response will be an well formatted XML and support for other formats like JSON will be available shortly.


API URL

After getting the 'API Key' and 'Ticket Id' as mentioned here, to access the API methods the users should use the format as mentioned below

http://sheet.zoho.com/api/xml?apikey=<API Key>&ticket=<Ticket Id>

a. If the calling convention is HTTP GET , the query parameters specific to the method should be added to the above URL
b. If the calling convention is HTTP POST, the request XML specific to the method, should to be sent in the HTTP POST body


API Methods

This section lists all methods which were currently supported. More methods will be continuously added. If you have a request for a
specific method, write to us at support (at) zohosheet (dot) com

• zohoSheet.userView.getWorkbooks - to get the list of workbooks available in your Zoho Sheet account
• zohoSheet.userView.saveWorkbook - to save the modified workbook into your Zoho Sheet account
  
• zohoSheet.userView.addWorkbook - to import a new workbook into your Zoho Sheet account
• zohoSheet.userView.renameWorkbook - to rename a workbook present in your Zoho Sheet account

Miscellaneous

To download the workbooks from your Zoho Sheet account in xls, csv or sxc( Openoffice Calc Document ) format, use the REST URL

http://sheet.zoho.com/open.do?docid=<docId>&ticket=<ticket>&export=< xls | sxc | csv >

Here,

• docid - is the unique workbookId representing your workbook
• ticket - is used for authenticating the above call. More details for getting the ticket here
  
• export - the format in which the workbook should be downloaded. For now,the formats xls , sxc and csv were supported.

Note: In case of csv download, only the contents of first sheet will be downloaded as opposed to downloading the entire workbook. In case, a specific sheet other than the first one needs to be downloaded, that sheet name can be specified using the additional query parameter 'sheetName'.

For example, the below URL can be used to download the content of sheet 'leads' (of workbook with id '10760000000011001'), in csv format

http://sheet.zoho.com/open.do?docid=10760000000011001&ticket=ed1e365d23271f0d3f091e28caa49496&export=csv&sheetName=leads

Moving forward, more API methods will be added to get the content of workbooks at fine grained levels (say a particular sheet,cell range, cell etc..)


A Sample Call to zohoSheet.userView.renameWorkbook method


Request

<methodCall>
    <methodName>zohoSheet.userView.renameWorkBook</methodName>
    <params>
        <Param>
            <name>workbookId</name>
            <value>10000000000026</value>
        </Param>
        <param>
            <name>newName</name>
            <value>Web2.0 Companies </value>
        </param>
    </params>
</methodCall>

<?xml version="1.0" encoding="UTF-8" ?>
<methodResponse methodName="zohosheet.userView.renameWorkbook">
    <result>
        <workbookId>10000000000026</workbookId>
        <workbookName>Web2.0 Companies</workbookName>
        <modifiedTime>2006-11-17 15:51:38</modifiedTime>
        <updateLock>1163758898734</updateLock>
    </result>
</methodResponse>

<?xml version="1.0" encoding="UTF-8" ?>
<methodResponse methodName="zohosheet.userView.renameWorkbook">
     <error>	
	<code>2851</code>
	<message>
	     The workbook with id 10000000000026 is not available in your account.	
	</message>
	<info>
	     <workbookId>10000000000026</workbookId>
	</info>
     </error>
</methodresponse>
	

Error Conditions

The list of error conditions the a user will get as a response on giving inconsistent/incorrect input values or under other exceptional cases, is listed here


Getting Started

To get started with the API usage, visit our Getting Started page