Skip to product menu
close
  • Sales
    Press Space or Enter to display list of options
EXPLORE ALL PRODUCTS

Sales

 
CRM

Comprehensive CRM platform for customer-facing teams.

CRM
 
Bigin

Simple CRM for small businesses moving from spreadsheets.

Bigin
 
Forms

Build online forms for every business need.

Forms
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Sign

Digital signature app for businesses.

Sign
 
RouteIQ

Comprehensive sales map visualization and optimal route planning solution.

RouteIQ
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
Suites
CRM Plus

Unified platform to deliver top-notch customer experience.

CRM Plus

Marketing

 
Social

All-in-one social media management software.

Social
 
Campaigns

Create, send, and track targeted email campaigns that drive sales.

Campaigns
 
Forms

Build online forms for every business need.

Forms
 
Survey

Design surveys to reach and interact with your audience.

Survey
 
Sites

Online website builder with extensive customisation options.

Sites
 
PageSense

Website conversion optimization and personalisation platform.

PageSense
 
Backstage

End-to-end event management software.

Backstage
 
Webinar

Webinar platform for webcasting online webinars.

Webinar
 
Marketing Automation

All-in-one marketing automation software.

Marketing Automation
 
LandingPage

Smart landing page builder to increase conversion rates

LandingPage
 
Publish

Manage all your local business listings on a single platform.

Publish
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Sign

Digital signature app for businesses.

Sign
 
Thrive

Complete loyalty and affiliate management platform.

Thrive
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
NEW
LeadChain

Sync, manage, and convert leads across channels seamlessly.

LeadChain
 
NEW
CommunitySpaces

Online community platform for individuals and businesses to grow their network and brand.

CommunitySpaces
 
Suites
Marketing Plus

Unified marketing platform for marketing teams.

Marketing Plus

Commerce and POS

 
Commerce

eCommerce platform to manage and market your online store.

Commerce

Service

 
Desk

Helpdesk software to deliver great customer support.

Desk
 
Assist

Remote support and unattended remote access software.

Assist
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
FSM

End-to-end field service management platform for service businesses.

FSM
 
SalesIQ

Live chat app to engage and convert website visitors.

SalesIQ
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
Suites
Service Plus

Unified platform for customer service and support teams.

Service Plus

Finance

 
Books

Powerful accounting platform for growing businesses.

Books
 
FREE
Invoice

100% Free invoicing solution.

Invoice
 
Expense

Effortless expense reporting platform.

Expense
 
Inventory

Powerful stock management and inventory control software.

Inventory
 
Billing

End-to-end billing solution for your business.

Billing
 
Checkout

Collect payments online with custom branded pages.

Checkout
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
Solo

The all-in-one toolkit for solopreneurs.

Solo
 
Practice

Practice management software for accounting firms.

Practice
 
Sign

Digital signature app for businesses.

Sign
 
Commerce

eCommerce platform to manage and market your online store.

Commerce
 
Suites
Finance Plus

All-in-one suite to manage your operations and finances.

Finance Plus

Email and Collaboration

 
Mail

Secure email service for teams of all sizes.

Mail
 
Meeting

Online meeting software for all your video conferencing & webinar needs.

Meeting
 
Writer

Word processor for focused writing and discussions.

Writer
 
Sheet

Spreadsheet software for collaborative teams.

Sheet
 
Show

Create, edit, and share slides with a sleek presentation app.

Show
 
Notebook

Beautiful home for all your notes.

Notebook
 
Cliq

Stay in touch with teams no matter where you are.

Cliq
 
Connect

Employee experience platform to communicate, engage, and build positive employee relations.

Connect
 
Bookings

Appointment scheduling app for consultations with customers.

Bookings
 
TeamInbox

Shared inboxes for teams.

TeamInbox
 
WorkDrive

Online file management for teams.

WorkDrive
 
Sign

Digital signature app for businesses.

Sign
 
Office Suite

Powerful collaborative work platform for teams.

Office Suite
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
Calendar

Online business calendar to manage events and schedule appointments.

Calendar
 
Learn

Knowledge and learning management platform.

Learn
 
Voice

Cloud Contact Center Software for businesses.

Voice
 
ToDo

Collaborative task management for individuals and teams.

ToDo
 
Tables

Work management tool to connect people, processes, and information.

Tables
 
FREE
PDF Editor

Collaborative online PDF editing tool.

PDF Editor
 
Suites
Workplace

Application suite built to improve team productivity and collaboration.

Workplace

Human Resources

 
People

Organize, automate, and simplify your HR processes.

People
 
Recruit

Intuitive recruiting platform built to provide hiring solutions.

Recruit
 
Expense

Effortless expense reporting platform.

Expense
 
Workerly

Manage temporary staffing with an employee scheduling solution.

Workerly
 
NEW
Payroll

Payroll software with automated tax payments and filing.

Payroll
 
Shifts

Employee scheduling and time tracking app.

Shifts
 
Sign

Digital signature app for businesses.

Sign
 
Suites
People Plus

Comprehensive HR platform for seamless employee experiences.

People Plus

Security and IT Management

 
Creator

Build custom apps to simplify business processes.

Creator
 
Directory

Workforce identity and access management solution for cloud businesses.

Directory
 
FREE
OneAuth

Secure multi-factor authenticator (MFA) for all your online accounts.

OneAuth
 
Vault

Online password manager for teams.

Vault
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Toolkit

Complete resource for any admin-related lookup queries.

Toolkit
 
Lens

Interactive remote assistance software with augmented reality.

Lens
 
Assist

Remote support and unattended remote access software.

Assist
 
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA

BI and Analytics

 
Analytics

Modern self-service BI and analytics platform.

Analytics
 
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI
 
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep
 
NEW
IoT

Harnessing IoT analytics for real-time operational intelligence.

IoT

Project Management

 
Projects

Manage, track, and collaborate on projects with teams.

Projects
 
Sprints

Planning and tracking tool for scrum teams.

Sprints
 
BugTracker

Automatic bug tracking software for managing bugs.

BugTracker
 
Solo

The all-in-one toolkit for solopreneurs.

Solo

Developer Platforms

 
Creator

Build custom apps to simplify business processes.

Creator
 
Flow

Automate business workflows by creating smart integrations.

Flow
 
Catalyst

Pro-code platform to build and deploy your apps.

Catalyst
 
Office Integrator

Built in document editors for web apps.

Office Integrator
 
ZeptoMail

Secure and reliable transactional email sending service.

ZeptoMail
 
QEngine

Test automation software to build, manage, execute, and report testcases.

QEngine
 
Tables

Work management tool to connect people, processes, and information.

Tables
 
NEW
RPA

Automate manual, tedious, and repetitive tasks easily.

RPA
 
NEW
Apptics

Application analytics for all apps.

Apptics
 
Embedded BI

Embedded analytics and white label BI solutions, tailored for your needs.

Embedded BI
 
NEW
IoT

Build, deploy, and scale IoT solutions for connected businesses.

IoT
 
DataPrep

AI-powered data preparation service for your data-driven organization.

DataPrep

IoT

 
NEW
IoT

Low-code IoT platform and solutions for connected businesses.

IoT

Search Result

 
CRM Plus

Unified platform to deliver top-notch customer experience.

Try now
CRM Plus
 
Service Plus

Unified platform for customer service and support teams.

Try now
Service Plus
 
Finance Plus

All-in-one suite to manage your operations and finances.

Try now
Finance Plus
 
People Plus

Comprehensive HR platform for seamless employee experiences.

Try now
People Plus
 
Workplace

Application suite built to improve team productivity and collaboration.

Try now
Workplace
 
Marketing Plus

Unified marketing platform for marketing teams.

Try now
Marketing Plus
 
All-in-one suite

Zoho One

The Operating System for Business

Run your entire business on Zoho with our unified cloud software, designed to help you break down silos between departments and increase organizational efficiency.

TRY ZOHO ONE
Zoho One
Zoho Marketplace

With over 2000 ready-to-use extensions across 40+ categories, connect your favorite business tools with the Zoho products you already use.

EXPLORE MARKETPLACE
Marketplace
Skip to main content

Projects API

Scope: ZohoBugTracker.projects.{Operation}

Operations: READ, CREATE, UPDATE, DELETE, ALL

Use the ALL operation to gain the scope for all the other operations like READ, CREATE, UPDATE, and DELETE at once.

All Projects
GET  /restapi/portal/[PORTALID]/projects/
Project Details
GET  /restapi/portal/[PORTALID]/projects/[PROJECTID]/
Get Project Custom Fields
Get  /restapi/portal/[PORTALID]/projects/customfields/
Create a Project
POST  /restapi/portal/[PORTALID]/projects/
Update a Project
POST /restapi/portal/[PORTALID]/projects/[PROJECTID]/
Delete a Project
DELETE  /restapi/portal/[PORTALID]/projects/[PROJECTID]/

All Projects

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

GET  /restapi/portal/[PORTALID]/projects/

Scope: ZohoBugTracker.projects.READ

Request Parameters

indexintIndex number of the project.
rangeintRange of the projects.
statusStringStatus of the project must be active or archived or template
sort_columnStringSort projects using the last modified time or time of creation. (created_time / last_modified_time)
sort_orderStringSort in ascending / descending order

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
    "projects": [{
        "custom_fields": [{
            "Template design": "Rightnav_temp"
        }, {
            "Promos per second": "2"
        }, {
            "Blog announcement": "02-25-2016"
        }, {
            "Promo publish date": "02-17-2016"
        }, {
            "Content approval": "Amritha Agrawal"
        }],
        "created_date": "02-16-2016",
        "IS_BUG_ENABLED": true,
        "owner_name": "Patricia Boyle",
        "task_count": {
            "open": 0,
            "closed": 0
        },
        "start_date_long": -32401001,
        "status": "active",
        "link": {
            "folder": {
                "url": "https://projectsapi.zoho.com/restapi/portal/zillum/projects/170876000003152069/folders/"
            },
            "milestone": {
                "url": "https://projectsapi.zoho.com/restapi/portal/zillum/projects/170876000003152069/milestones/"
            },
            "forum": {
                "url": "https://projectsapi.zoho.com/restapi/portal/zillum/projects/170876000003152069/forums/"
            },
            "document": {
                "url": "https://projectsapi.zoho.com/restapi/portal/zillum/projects/170876000003152069/documents/"
            },
            "status": {
                "url": "https://projectsapi.zoho.com/restapi/portal/zillum/projects/170876000003152069/statuses/"
            },
            "event": {
                "url": "https://projectsapi.zoho.com/restapi/portal/zillum/projects/170876000003152069/events/"
            },
   
            "bug": {
                "url": "https://projectsapi.zoho.com/restapi/portal/zillum/projects/170876000003152069/bugs/"
            },
            "self": {
                "url": "https://projectsapi.zoho.com/restapi/portal/zillum/projects/170876000003152069/"
            },
            "timesheet": {
                "url": "https://projectsapi.zoho.com/restapi/portal/zillum/projects/170876000003152069/logs/"
            },
            "user": {
                "url": "https://projectsapi.zoho.com/restapi/portal/zillum/projects/170876000003152069/users/"
            },
            "tasklist": {
                "url": "https://projectsapi.zoho.com/restapi/portal/zillum/projects/170876000003152069/tasklists/"
            },
            "activity": {
                "url": "https://projectsapi.zoho.com/restapi/portal/zillum/projects/170876000003152069/activities/"
            }
        },
        "created_date_format": "02-16-2016 03:20:43 AM",
        "workspace_id": "2ea4657bfe29202df4eda90dabc651e61b1d6",
        "milestone_count": {
            "open": 0,
            "closed": 0
        },
        "created_date_long": 1455621643662,
        "end_date_format": "12-31-1969 06:59:59 AM",
        "id": 170876000003152069,
        "end_date": "12-31-1969",
        "id_string": "170876000003152069",
        "description": "fdb df b",
        "name": "Promotional banner for women's day",
        "owner_id": "2060758",
        "end_date_long": -32401001,
        "role": "admin",
        "start_date_format": "12-31-1969 06:59:59 AM",
        "start_date": "12-31-1969"
    }]
}

Project Details

Lists all the details of the project.

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

Scope: ZohoBugTracker.projects.READ

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/"
            },
            
            "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/"
            }
        }
    }]
}

Get Project Custom Fields

Gets all the project custom fields.

GET  /restapi/portal/[PORTALID]/projects/customfields/

Note:

  • To create projects with custom fields, you need to pass the value received for the field_id in this response. The value that you receive here becomes the param in the Create a Project API.

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8
{
    "project_custom_fields": [{
        "is_visible": true,
        "field_name": "Supported browser",
        "field_type": "single_line",
        "default_value": "Chrome",
        "field_id": "UDF_CHAR1"
    }, {
        "is_visible": true,
        "field_name": "Due Date",
        "field_type": "date",
        "field_id": "UDF_DATE1"
    }]
}

Create a Project

POST  /restapi/portal/[PORTALID]/projects/

Scope: ZohoBugTracker.projects.CREATE

Request Parameters

name*String [100]Name of the project.
ownerLongZoho user ID. If this param is not set, the user who creates the project will be mapped as the owner by default.
descriptionStringDescription of the project.
template_idLongTemplate ID of the project.
start_dateString [MM-DD-YYYY]Start date of the project.
end_dateString [MM-DD-YYYY]End date of the project.
strict_projectStringThe value for strict projects must be either 1 or 2. (1 = Not strict, 2 = Strict)

<field_id>

ex: UDF_CHAR1

StringThe value of the custom field.

Note:

  • The project custom field feature is available only in the Enterprise plan. The params that you need to pass for the project custom fields is the value in <field_id> in Get Project Custom Fields API.
  • Strict project feature is available only for paid plans.

Example of creating a project with custom fields

Since custom field names are not unique, custom fields are referred by their respective < field_id>. The same custom field name will be referred with different field Ids. 

You must first get all the custom fields, and then pass the <field_id> value of the custom field as a param to create your project with the custom fields.

Here is a sample response of a custom field:

{
     "project_custom_fields": [{
         "is_visible": false,
         "field_name": "Supported browser",
         "field_type": "single_line",
         "default_value": "Chrome",
        "field_id": "UDF_CHAR1"
     }]
}    

UDF_CHAR1 is the param that you need to pass while creating projects. 

Firefox is the value for the "Supported browser" field. 

Notice that the name of the field Supported browser" will not be used anywhere while creating projects.

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/"
            },
            
            "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  /restapi/portal/[PORTALID]/projects/[PROJECTID]/

Scope: ZohoBugTracker.projects.UPDATE

Request Parameters

nameString [100]Name of the project.
ownerLongUser ID.
descriptionStringDescription of the project.
statusStringStatus of the project must be active or archived.
start_dateString [MM-DD-YYYY]Start date of the project.
end_dateString [MM-DD-YYYY]End date of the project.
strict_projectStringThe value for strict projects must be either 1 or 2. (1 = Not strict, 2 = Strict)

<field_id>

ex: UDF_CHAR1

StringThe value of the custom field.

Example of updating a project with custom fields

Since custom field names are not unique, custom fields are referred by their respective < field_id>. The same custom field name will be referred with different field Ids. 

You must first get all the custom fields, and then pass the <field_id> value of the custom field as a param to update your project with the custom fields.

Here is a sample response of a custom field:

{
     "project_custom_fields": [{
         "is_visible": false,
         "field_name": "Supported browser",
         "field_type": "single_line",
         "default_value": "Firefox",
        "field_id": "UDF_CHAR1"
     }]
}    

UDF_CHAR1 is the param that you need to pass while updating projects. 

Chrome is the value for the "Supported browser" field. 

Notice that the name of the field Supported browser" will not be used anywhere while updating projects.

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/"
            },
            
            "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  /restapi/portal/[PORTALID]/projects/[PROJECTID]/

Scope: ZohoBugTracker.projects.DELETE

Sample Response

Status: 200 Success

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