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

Get a list of sheets from a public workbook.

 
Request URL :

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

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

Response fields

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

Field	Description
sheet index, name	Unique number associated with each sheet in a particular workbook.If a workbook consists of 8 sheets the sheet index will be numbered from 1 to 8 along with sheet name.

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/sheets/1001000000002191">
  <result>

    <sheets>
        <sheet index="1" name="Sheet1" />
        <sheet index="2" name="Sheet2" />
        <sheet index="3" name="Sheet3" />
        </sheets>

  </result>
</response>

Equivalent JSON response

{
  "response":
   {
        "uri": "/api/public/json/sheets/1001000000002191",
        "result":
        {
           "sheets":
            {
                "sheet":
                [
                     {
                        "index":"1",
                        "name":"Sheet1"
                     },
                     {
                        "index":"2",
                        "name":"Sheet2"
                     },
                     {
                        "index":"3",
                        "name":"Sheet3"
                     }
                ]
            }
         }
    }
}  

Errors

Displaying list of sheets in a public workbook method may return general errors. Other likely HTTP error code is 2851.