Document List APIs

Tags:  


This topic is deprecated. Please access the new set of "Document List APIs" from over here: "https://www.zoho.com/docs/zoho-docs-api.html




Document List APIs

The document list apis, as the name suggests, is used to get a detailed list of all the documents, presentations & spreadsheets associated with a particular Zoho Account. This also includes particulars of a list of shared, trashed and public documents present in a user's account.

Request URI:

Developers can send the request in the following URI format :

Zoho Writer (Documents) :
https://writer.zoho.com/api/<access>/<format>/documents?apikey=[API Key]&authtoken=[AuthToken]&scope=DataAPI
Zoho Sheet (Spreadsheets) :
https://sheet.zoho.com/api/<access>/<format>/books?apikey=[API Key]&authtoken=[AuthToken]&scope=DataAPI
Zoho Show (Presentations) :
https://show.zoho.com/api/<access>/<format>/presentations?apikey=[API Key]&authtoken=[AuthToken]&scope=DataAPI
Access : private or public

Format : xml, json

HTTP Method : GET

Request Parameters Reference

Parameter Value
Description
start-from
integer
Optional. Sets the initial document number from which the documents will be listed. If there are 10 documents and start-from value is set to 3, then the documents will be listed from the 3rd document.
limit
integer
Optional. Sets the number of documents to be listed. If the limit value is set to 5 then the number of documents listed is 5.
order-by
string - (createdTime | lastModifiedTime | name)
Optional. Order documents by createdTime, lastModifiedTime & document name.
sort-order
string - (asc | desc) Optional. Arrange the workbooks in ascending or descending order. Default sorting is done in descending order.

Document List Methods :

Method Name URI Request
Description
List all documents
Writer: https://writer.zoho.com/api/private/xml/documents?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI

Sheet: https://sheet.zoho.com/api/private/xml/books?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI

Show: https://show.zoho.com/api/private/xml/presentations?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI
Lists all the documents, spreadsheets and presentations associated with a user's Zoho Account.
List all "shared" documents
Writer: https://writer.zoho.com/api/private/xml/incomingdocuments?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI

Sheet: https://sheet.zoho.com/api/private/xml/incomingbooks?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI

Show: https://show.zoho.com/api/private/xml/incomingpresentations?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI
Lists all the documents, spreadsheets and presentations that have been "shared" to a user's Zoho Account.
List all "trashed" documents Writer: https://writer.zoho.com/api/private/xml/trasheddocuments?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI

Sheet: https://sheet.zoho.com/api/private/xml/trashedbooks?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI

Show: https://show.zoho.com/api/private/xml/trashedpresentations?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI
Lists all the documents, spreadsheets and presentations that have been "trashed" from a user's Zoho Account.
List of public documents for a Zoho Account
Writer: https://writer.zoho.com/api/private/xml/publicdocuments?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI

Sheet: https://sheet.zoho.com/api/public/xml/books/user/[username]?apikey=[APIKey]

Show: https://show.zoho.com/api/private/xml/publicpresentations?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI
 
Lists all the documents, spreadsheets and presentations that have been made "public" from a user's Zoho Account.
List of documents associated with a tag-name
Writer: https://writer.zoho.com/api/private/xml/documents/tag/[tagname]?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI

Sheet: https://sheet.zoho.com/api/private/xml/books/tag/[tagname]?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI

Show: https://show.zoho.com/api/private/xml/presentations/tag/[tagname]?apikey=[APIKey]&authtoken=[AuthToken]&scope=DataAPI

Lists all the documents, spreadsheets and presentations that have been tagged by a user with a common tag-name.

Response Parameters Reference

Documents :

Parameter Value
Description
documentId
integer
Unique ID associated with each document in the list.
documentName
string
Name of one of the documents that is being listed.
version
string
Specifies the last saved version of the document
lastModifiedTime
long integer 
Displays the last modified time as long integer.
lastModifiedBy
string
Specifies the name of the user who has last edited the document. If the document is modified by the owner, then it displays "Me".
writePermission
boolean
Checks whether the access privileges is read only or read/write for the shared users. If false, then the shared users can only read the document content.
document_name_url
string
Unique document url to differentiate multiple documents having similar name
shared_users
string
Displays the list of email addresses to whom the document has been shared. Shows blank in case sharing access is disabled
document_locked
boolean
Checks whether the document has been locked exclusively for editing in a shared environment. True means the lock is enabled
document_blogged
boolean
Checks whether the document has been posted to any of the blog services. False status indicates that the document is not posted to any of the blog services.
author_name
string
Displays the Email ID/Zoho ID of the document owner, i.e., the account from which the document is created.
created_date
long integer
Displays the created date of the document. E.g. 1180532581984.
category
string
Displays the category of the document, whether 'OWNED' or 'SHARED'

Spreadsheets :

Parameter Value
Description
workbookId
integer
Unique ID associated with each workbook in the list.
workbookName
string
Name of one of the workbooks that is being listed.
createdTime
long integer
Number of milliseconds between the workbook created time and midnight, January 1, 1970 UTC.
lastModifiedTime
long integer
Number of milliseconds between the last modified time and midnight, January 1, 1970 UTC.
lastModifiedBy
string
Specifies the Email ID of the person who has last edited the workbook. In case the workbook is shared & it is edited by one of the invitees, then the Email ID will be different from that of the author_name's ID.
lockedBy
boolean
Checks whether the workbook has been locked exclusively for editing in a shared environment by a user.
updateLock
string
Ensures that updates made to workbook are consistent when concurrent edit requests are sent to the same workbook.

Presentations :

Parameter Value
Description
presentationId integer
Unique ID associated with each presentation in the list.
presentationName string
Name of one of the workbooks that is being listed.
presentationNameUrl string
Url of the presentation that is being listed.
ownerName string
Displays the Email ID/Zoho ID of the presentation owner, i.e., the account from which the presentation is created
createdTime string
Number of milliseconds between the presentation created time and midnight, January 1, 1970 UTC.
isPublic boolean
Specifies the access privileges of the presentation. If "true" then presentation is available to public
lastModifiedTime
long integer
Displays the last modified time as long integer.
lastModifiedBy
string
Specifies the name of the user who has last edited the presentation.
slideTransitionTime integer
The time interval, in seconds, between two slides in a presentation
lockedBy string
Name of the user who has exclusively locked the shared presentation for editing.

Sample Response :

The following is a response (both in XML & JSON) for getting a list of Zoho Writer documents from a Zoho account.

XML
<?xml version="1.0" encoding="UTF-8" ?> 
<response uri="/api/private/xml/documents">
<result>
<documents>
<document>
<documentId>7000000004003</documentId>
<documentName>Resume</documentName>
<version>1.4</version>
<lastModifiedTime>1176118084655</lastModifiedTime>
<lastModifiedBy>Me</lastModifiedBy>
<writePermission>false</writePermission>
<document_name_url>Resume</document_name_url>
<shared_users>[]</shared_Users>
<document_locked>false</document_locked>
<document_blogged>false</document_blogged>
<authorName>Gary</authorName>
<created_date>1180532581984</created_date>
<category>OWNED</category>
</document>
</documents>
</result>
</response>
JSON
{
"response":
{
"uri": "/api/private/json/documents",
"result":
{
"documents":
{
"document":
[
{
"documentId":"7000000004003",
"documentName":"Resume",
"version":"1.4",
"lastModifiedTime":"1176118084655",
"lastModifiedBy":"Me",
"writePermission":"false",
"document_name_url":"Resume",
"shared_users":"[]",
"document_locked":"false",
"document_blogged":"false",
"authorName":"Gary",
"created_date":"1180532581984",
"category":"Owned",
}
]
}
}
}
}




    Post a comment

    Your Name or E-mail ID (mandatory)

    Note: Your comment will be published after approval of the owner.




     RSS of this page