API Home >> Sheet >> API Reference >> sharing

Get a list of workbooks shared to the user.

Request URL :

                                XML : http://sheet.zoho.com/api/private/xml/incomingbooks?apikey=[API Key]&ticket=[Ticket]

                                JSON : http://sheet.zoho.com/api/private/json/incomingbooks?apikey=[API Key]&ticket=[Ticket]

Response fields

Field	Description
workbookId	Unique ID associated with each shared workbook in the list.
workbookName	Name of one of the shared workbooks that is being listed.
ownerName	Name of the workbook owner who has shared the book to you.
createdTime	Number of milliseconds between the workbook created time and midnight, January 1, 1970 UTC.
lastModifiedTime	Number of milliseconds between the last modified time and midnight, January 1, 1970 UTC.
lastModifiedBy	Specifies the Zoho ID/Email ID of the person who has last edited the shared workbook.
lockedBy	Checks whether the workbook has been locked exclusively for editing in a shared environment by a user.

Sample Response

The following is the sample XML response for the above method:

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/api/private/xml/incomingbooks">
  <result>
    <incomingWorkbooks>
      <incomingWorkbook>
        <workbookId>23445000000007001</workbookId>
        <workbookName>Book1</workbookName>
        <ownerName>007</ownerName>
        <createdTime>1172137033182</createdTime>
        <lastModifiedTime>1180593219644</lastModifiedTime>
        <lastModifiedBy>ahmed1</lastModifiedBy>
        <lockedBy />
          </incomingWorkbook>
      <incomingWorkbook>
        <workbookId>23445000000007015</workbookId>
        <workbookName>raja</workbookName>
        <ownerName>007</ownerName>
        <createdTime>1174374756812</createdTime>
        <lastModifiedTime>1175593219644</lastModifiedTime>
        <lastModifiedBy>007</lastModifiedBy>
        <lockedBy />
          </incomingWorkbook>
    </incomingWorkbooks>
  </result>
</response>

Equivalent JSON response

{
  "response":
   {
        "uri": "/api/private/json/incomingbooks",
        "result":
        {
           "incomingWorkbooks":
            {
                "incomingWorkbook":
                [
                    {
                        "workbookId":"23445000000007001",
                        "workbookName":"Book1",
                        "ownerName":"007",
                        "createdTime":1172137033182,
                        "lastModifiedTime":1180593219644,
                        "lastModifiedBy":"ahmed1",
                        "lockedBy":""
                     },
                     {
                        "workbookId":"23445000000007015",
                        "workbookName":"raja",
                        "ownerName":"007",
                        "createdTime":1174374756812,
                        "lastModifiedTime":1175593219644,
                        "lastModifiedBy":"007",
                        "lockedBy":""
                     }
                ]
            }
         }
    }
}  

Errors

Displaying list of workbooks shared to you method may return general errors.