Zoho Projects API for Developers

Projects API

All Projects
GET  /portal/[PORTALID]/projects/
Project Details
GET  /portal/[PORTALID]/projects/[PROJECTID]/
Create a Project
POST  /portal/[PORTALID]/projects/
Update a Project
POST /portal/[PORTALID]/projects/[PROJECTID]/
Delete a Project
DELETE  /portal/[PORTALID]/projects/[PROJECTID]/

All Projects

GET  /portal/[PORTALID]/projects/

Gets all the projects in the portal for the logged in user.

Request Parameters

index int Index number of the project.
range int Range of the projects.
status String Status of the project must be active or archived or template

Sample Response

Status: 200 Success
Content Type: application/json;charset=utf-8
{
"projects": [{
"id": 170876000001817031,
"task_count": {
"open": 15,
"closed": 5
},
"milestone_count": {
"open": 18,
"closed": 7
},
"bug_count": {
"open": 22,
"closed": 11
},
"name": "Warehouse ledgers",
"status": "active",
"created_date": "05-07-2014 12:18 PM",
"created_date_long": 1399474096501,
"description": "Count of stocks",
"owner_name": "Patricia Boyle",
"owner_id": "2060758",
"link": {
"self": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001817031/"
},
"activity": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001817031/activities/"
},
"status": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001817031/statuses/"
},
"milestone": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001817031/milestones/"
},
"tasklist": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001817031/tasklists/"
},
"task": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001817031/tasks/"
},
"bug": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001817031/bugs/"
},
"timesheet": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001817031/logs/"
},
"event": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001817031/events/"
},
"document": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001817031/documents/"
},
"folder": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001817031/folders/"
},
"forum": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001817031/forums/"
},
"user": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001817031/users/"
}
}
}]
}

Project Details

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

List the details of the project.

Sample Response

Status: 200 Success
Content Type: application/json;charset=utf-8
{
"projects": [{
"id": 170876000000765009,
"task_count": {
"open": 6,
"closed": 7
},
"milestone_count": {
"open": 2,
"closed": 1
},
"bug_count": {
"open": 2,
"closed": 1
},
"name": "Website Design Templates",
"status": "active",
"created_date": "10-22-2012 02:45 PM",
"created_date_long": 1350926134092,
"description": "This project is to discuss different design templates to build a website",
"owner_name": "Patricia Boyle",
"owner_id": "2060758",
"link": {
"self": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000000765009/"
},
"activity": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000000765009/activities/"
},
"status": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000000765009/statuses/"
},
"milestone": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000000765009/milestones/"
},
"tasklist": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000000765009/tasklists/"
},
"task": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000000765009/tasks/"
},
"bug": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000000765009/bugs/"
},
"timesheet": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000000765009/logs/"
},
"event": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000000765009/events/"
},
"document": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000000765009/documents/"
},
"folder": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000000765009/folders/"
},
"forum": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000000765009/forums/"
},
"user": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000000765009/users/"
}
}
}]
}

Create a Project

POST  /portal/[PORTALID]/projects/

Creates a new project.

Request Parameters

name* String [100] Name of the project.
description String Description of the project.
template_id Long Template ID of the project.

Sample Response

Status: 201 Created
Content Type: application/json;charset=utf-8
  {
"projects": [{
"id": 170876000001849005,
"task_count": {
"open": 0,
"closed": 0
},
"milestone_count": {
"open": 0,
"closed": 0
},
"bug_count": {
"open": 0,
"closed": 0
},
"name": "SAP Projects",
"status": "active",
"created_date": "05-26-2014 10:34 AM",
"created_date_long": 1401109494737,
"description": "This project is used to implement end to end SAP for large scale companies.",
"owner_name": "Patricia Boyle",
"owner_id": "2060758",
"link": {
"self": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/"
},
"activity": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/activities/"
},
"status": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/statuses/"
},
"milestone": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/milestones/"
},
"tasklist": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/tasklists/"
},
"task": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/tasks/"
},
"bug": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/bugs/"
},
"timesheet": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/logs/"
},
"event": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/events/"
},
"document": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/documents/"
},
"folder": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/folders/"
},
"forum": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/forums/"
},
"user": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/users/"
}
}
}]
}

Update a Project

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

Updates the project.

Request Parameters

name* String [100] Name of the project.
description String Description of the project.
status* String Status of the project must be active or archived.

Sample Response

Status: 200 Success
Content Type: application/json;charset=utf-8
{
"projects": [{
"id": 170876000001849005,
"task_count": {
"open": 22,
"closed": 11
},
"milestone_count": {
"open": 15,
"closed": 7
},
"bug_count": {
"open": 18,
"closed": 8
},
"name": "SAP Projects",
"status": "archived",
"created_date": "05-26-2014 10:34 AM",
"created_date_long": 1401109494737,
"description": "The project has been successfully implemented in 100 companies.",
"owner_name": "Patricia Boyle",
"owner_id": "2060758",
"link": {
"self": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/"
},
"activity": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/activities/"
},
"status": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/statuses/"
},
"milestone": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/milestones/"
},
"tasklist": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/tasklists/"
},
"task": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/tasks/"
},
"bug": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/bugs/"
},
"timesheet": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/logs/"
},
"event": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/events/"
},
"document": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/documents/"
},
"folder": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/folders/"
},
"forum": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/forums/"
},
"user": {
"url": "https://projectsapi.zoho.com/restapi/portal/
2063927/projects/170876000001849005/users/"
}
}
}]
}

Delete a Project

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

Deletes the project.

Sample Response

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

Top