Zoho Projects API for Developers
The Documents API will be deprecated as it will shortly be merged with Zoho Docs.

Documents and Folders API

All Documents
GET  /portal/[PORTALID]/projects/[PROJECTID]/documents/
Version Details of the Document
GET  /portal/[PORTALID]/projects/[PROJECTID]/documents/[DOCUMENTID]/
Add Document
POST  /portal/[PORTALID]/projects/[PROJECTID]/documents/
Upload Latest Document
POST  /portal/[PORTALID]/projects/[PROJECTID]/documents/[DOCUMENTID]/
Delete Document
DELETE /portal/[PORTALID]/projects/[PROJECTID]/documents/[DOCUMENTID]/
All Folder
GET  /portal/[PORTALID]/projects/[PROJECTID]/folders/
Add Folder
POST  /portal/[PORTALID]/projects/[PROJECTID]/folders/
Update Folder
POST  /portal/[PORTALID]/projects/[PROJECTID]/folders/[FOLDERID]/
Delete Folder
DELETE /portal/[PORTALID]/projects/[PROJECTID]/folders/[FOLDERID]/

All Documents

GET  /portal/[PORTALID]/projects/[PROJECTID]/documents/

Gets all the documents in the given project.

Request Parameters

index int Index number of the document.
range int Range of the documents.
folder_id Long ID of the project folder.

Sample Response

Status: 200 Success
Content Type: application/json;charset=utf-8
{
"documents": [{
"id": 170876000001823043,
"file_name": "business_manual.pdf",
"content_type": "application/pdf",
"versions": [{
"id": 170876000001823045,
"uploaded_by": "Patricia Boyle",
"description": "Business Manual",
"file_size": "421 kB",
"version": "1.1",
"uploaded_date": "05-09-2014 11:56 AM",
"uploaded_date_long": 1399645597255
}],
"folder": {
"id": 170876000000147017,
"name": "ERP Phase III",
"is_discussion": "false"
},
"link": {
"self": {
"url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/
170876000000147021/documents/170876000001823043/"
}
}
}]
}

Version Details of the Document

GET  /portal/[PORTALID]/projects/[PROJECTID]/documents/[DOCUMENTID]/

Gets the version details of the document.

Request Parameters

version String Version number of the document .

Sample Response

Status: 200 Success
Content Type: application/json;charset=utf-8
{{
"documents": [{
"id": 170876000000270123,
"file_name": "submit_accountinfo.asp.htm",
"content_type": "text/html",
"versions": [{
"id": 170876000000270459,
"uploaded_by": "Patricia Boyle",
"description": "New version with latest account details",
"file_size": "6 kB",
"version": "1.2",
"uploaded_date": "01-14-2011 06:07 PM",
"uploaded_date_long": 1295037468646
}],
"link": {
"self": {
"url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/
170876000000147021/documents/170876000000270123/"
}
}
}]
}

Add Document

POST  /portal/[PORTALID]/projects/[PROJECTID]/documents/

Uploads the document.

Request Parameters

uploaddoc* File The selected file for upload.
folder_id Long ID of the project folder.
description String Description of the document.
tags String Document tags must be separated by space or comma.
notify Long User ID's must be separated by commas for multiple users.

Sample Response

Status: 201 Created
Content Type: application/json;charset=utf-8
{
"documents": [{
"id": 170876000001849061,
"file_name": "business_manual.pdf",
"content_type": "application/pdf",
"versions": [{
"id": 170876000001849063,
"uploaded_by": "Patricia Boyle",
"description": "",
"file_size": "421 kB",
"version": "1.1",
"uploaded_date": "05-26-2014 03:57 PM",
"uploaded_date_long": 1401128861699
}],
"link": {
"self": {
"url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/
170876000000147021/documents/170876000001849061/"
}
}
}]
}

Upload Latest Document

POST  /portal/[PORTALID]/projects/[PROJECTID]/documents/[DOCUMENTID]/

Uploads the latest version of the document.

Request Parameters

uploaddoc* File The selected file for upload.
folder_id* Long ID of the project folder.
description String Description of the document.
tags String Document tags must be separated by space or comma.
notify Long User ID's must be separated by commas for multiple users.

Sample Response

Status: 200 Success
Content Type: application/json;charset=utf-8
{
"documents": [{
"id": 170876000001849061,
"file_name": "business_manual.pdf",
"content_type": "application/pdf",
"versions": [{
"id": 170876000001849071,
"uploaded_by": "Patricia Boyle",
"description": "",
"file_size": "421 kB",
"version": "1.2",
"uploaded_date": "05-26-2014 03:59 PM",
"uploaded_date_long": 1401128953981
}],
"link": {
"self": {
"url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/
170876000000147021/documents/170876000001849061/"
}
}
}]
}

Delete Document

DELETE /portal/[PORTALID]/projects/[PROJECTID]/documents/[DOCUMENTID]/

Deletes the document.

Sample Response

Status: 200 Success
Content Type: application/json;charset=utf-8
{
"response": "Document Deleted Successfully"
}

All Folders

GET  /portal/[PORTALID]/projects/[PROJECTID]/folders/

Gets all the folders in the given project.

Sample Response

Status: 200 Success
Content Type: application/json;charset=utf-8
{
"folders": [{
"id": 170876000000170323,
"name": "Invoices",
"is_discussion": false,
"link": {
"self": {
"url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/
170876000000147021/folders/170876000000170323/"
}
}
}]
}

Add Folder

POST  /portal/[PORTALID]/projects/[PROJECTID]/folders/

Adds the given folder.

Request Parameters

name* String Name of the folder.

Sample Response

Status: 201 Created
Content Type: application/json;charset=utf-8
{
"folders": [{
"id": 170876000000170323,
"name": "Journal Entries",
"is_discussion": false,
"link": {
"self": {
"url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/
170876000000147021/folders/170876000000170323/"
}
}
}]
}

Update Folder

POST  /portal/[PORTALID]/projects/[PROJECTID]/folders/[FOLDERID]/

Updates the folder.

Request Parameters

name* String Name of the folder.

Sample Response

Status: 200 Success
Content Type: application/json;charset=utf-8
{
"folders": [{
"id": 170876000000170323,
"name": "Journal Entry",
"is_discussion": false,
"link": {
"self": {
"url": "https://projectsapi.zoho.com/restapi/portal/2063927/projects/
170876000000147021/folders/170876000000170323/"
}
}
}]
}

Delete Folder

DELETE /portal/[PORTALID]/projects/[PROJECTID]/folders/[FOLDERID]/

Deletes the given folder.

Sample Response

Status: 200 Success
Content Type: application/json;charset=utf-8
{
"response": "Folder Deleted Successfully"
}

Top