API Home >> Sheet >> API Reference >> books

Get a list of public workbooks available in Zoho Sheet.

Request URL :

                                XML : http://sheet.zoho.com/api/public/xml/books?apikey=[API Key]

                                JSON : http://sheet.zoho.com/api/public/json/books?apikey=[API Key]


Request parameters

Field	Description
start-from [optional]	[integer] - Sets the initial workbook number from which the public workbooks will be listed. If there are 10 publlc workbooks and start-from value is set to 3, then the workbooks will be listed from the 3rd workbook.
limit [optional]	[integer] - Sets the number of workbooks to be listed. If the limit value is set to 5 then the number of public workbooks listed is 5.

Response fields

The schema document for the API response is located at: http://sheet.zoho.com/schema/publicbooks.xsd

Field	Description
workbookId	Unique ID associated with each public workbook in the list.
workbookName	Name of one of the public workbooks that is being listed.
authorName	Displays the name of the author of the public workbook.
permaLink	Displays the link of the public workbook.
embedLink	Displays the link that can be used for embedding this workbook in other web pages.

Sample Response

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

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/api/public/xml/books">
  <result>
    <publicWorkbooks>
      <publicWorkbook>
        <workbookId>6000000004003</workbookId>
        <workbookName>Downloads_by_region</workbookName>
        <authorName>gary</authorName>
        <permaLink>          <![CDATA[http://zohosheet/public.do?docurl=Downloads_by_region&name=ER4OKJyDUI4%3D]]>
        </permaLink>
        <embedLink>          <![CDATA[http://zohosheet/publish.do?docurl=Downloads_by_region&name=ER4OKJyDUI4%3D]]>
        </embedLink>
         </publicWorkbook>
      <publicWorkbook>
        <workbookId>6000000002011</workbookId>
        <workbookName>Research List</workbookName>
        <authorName>demo</authorName>
        <permaLink>
<![CDATA[http://zohosheet/public.do?docurl=Research+List&name=PdmGsnVvhxI%3D]]>
        </permaLink>
        <embedLink>
<![CDATA[http://zohosheet/publish.do?docurl=Research+List&name=PdmGsnVvhxI%3D]]>
        </embedLink>
      </publicWorkbook>
     </publicWorkbooks>
  </result>
</response>

Equivalent JSON response

{
  "response":
   {
        "uri": "/api/public/json/books",
        "result":
        {
           "publicWorkbooks":
            {
                "publicWorkbook":
                [
                    {
                        "workbookId":"6000000004003",
                        "workbookName":"Downloads_by_region",
                        "authorName":"gary",
                        "permaLink":
"<![CDATA[http://zohosheet/public.do?docurl=rgyDJ5UUFfoomvvL4Zx3UQ%3D%3D&name=ER4OKJyDUI4%3D]]>",
                        "embedLink":
"<![CDATA[http://zohosheet/publish.do?docurl=rgyDJ5UUFfoomvvL4Zx3UQ%3D%3D&name=ER4OKJyDUI4%3D]]>"
                     },
                     {
                        "workbookId":"6000000002011",
                        "workbookName":"Research List",
                        "authorName":"demo",
                        "permaLink": "<![CDATA[http://zohosheet/public.do?docurl=Research+List&name=PdmGsnVvhxI%3D]]>",
                        "embedLink": "<![CDATA[http://zohosheet/publish.do?docurl=Research+List&name=PdmGsnVvhxI%3D]]>"
                     }
                ]
            }
         }
    }
}  

Errors

Displaying list of public workbooks method may return general & input errors.