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

Get a list of sheets in a specific workbook.

  
Request URL :

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

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


Response fields

Field	Description
sheet	Sheets displayed along with index and name parameters. Index is a unique id associated with each sheet in a particular workbook.Sheet name can be customized by user or by default it is named as Sheet followed by index

Sample Response

The following is the sample response for the above method:

<?xml version="1.0" encoding="UTF-8" ?>
<response uri="/api/private/xml/sheets/15265000000001065">
  <result>

    <sheets>
        <sheet index="1" name="DataSortbyName" />
        <sheet index="2" name="DataSortbyCreatedDate" />
        <sheet index="3" name="DataSortbyModifiedDate" />
        <sheet index="4" name="DataSortbyAuthor" />
    </sheets>

  </result>
</response>

Equivalent JSON response

{
  "response":
   {
        "uri": "/api/private/json/sheets/15265000000001065",
        "result":
        {
           "sheets":
            {
                "sheet":
                [
                     {
                        "index":"1",
                        "name":"DataSortbyName"
                     },
                     {
                        "index":"2",
                        "name":"DataSortbyCreatedDate"
                     },
                     {
                        "index":"3",
                        "name":"DataSortbyModifiedDate"
                     },
                     {
                        "index":"4",
                        "name":"DataSortbyAuthor"
                     }
                ]
            }
         }
    }
}  

Errors

Displaying list of sheets in a workbook method may return general & input errors.