Get Project Details From Zoho Projects

Table of Contents

Note:

  • Each time the zoho.projects.getProjectDetails integration task is executed, it triggers an API request in the back-end. This call is deducted from the external calls limit available for the service from which the task is executed, based on your pricing plan.
  • Only actual executions that receive a response (whether success or failure) are counted, not the number of times the task appears in the script. For example, if zoho.projects.getProjectDetails integration task is placed inside a for each task that iterates five times, the number of external calls consumed will be five, even though the task appears only once in the script. 

Description

The zoho.projects.getProjectDetails task fetches all the projects from the specified portal in Zoho Projects.

Note: For security reasons, if you execute Zoho Projects integration tasks for more than 100 times under 2 minutes, you will be restricted to execute any Zoho Projects integration task for the next 30 mins.

Syntax

<response>=zoho.projects.getProjectDetails(<portal>, [<status>], [<connection>]);

where:

ParamsData typeDescription
<response> KEY-VALUEThe list of all projects from the specified portal, as well as their respective IDs and statuses.
<portal> TEXT/ NUMBER

The name or ID of the portal from which the project details need to be fetched.

Note: You can get the name or ID of the portal using the get portals task. Click here to learn more about it.

<status>

(optional)

TEXT

The status of the project.

Allowed values:

  • active - Lists all the active projects.
  • archived - Lists all the archived projects.
  • template - Lists all the project templates.

Note: This parameter is applicable to all Zoho services, except Zoho Creator.

<connection>

(optional)

TEXT

The link name of the connection.

Note: This parameter is applicable to all Zoho services that has connections support, except Zoho Creator.

Note:

In integration tasks, the parameters must be in the defined order as given in the syntax, for the Deluge task to be executed. If you choose to use an optional parameter, ensure that all preceding parameters in the syntax are explicitly specified. If a preceding optional parameter is not required, a null value can be assigned instead, to maintain the defined syntax order.

For example, in the below syntax, options_map and connection are optional parameters:

<variable> = zoho.crm.v8.task (<module_name>, <record_details>, <options_map>, <connection>);

If you want to use the connection parameter, module_name, record_details and options_map must be specified in the 
exact order as the syntax. You can assign an empty map to the options_map parameter if it is not required.

 

Example

The following script fetches all the active projects from the portal - zylker:

response = zoho.projects.getProjectDetails("zylker", "active");

where:

response
The KEY-VALUE response returned by Zoho Projects.
"zylker"
The TEXT that represents the name of the portal from which the projects need to be fetched.
"active"
The TEXT that represents the status of the project. Here, only the active projects are fetched.

Response Format

Success Response

  • The success response will be returned in the following format:

      {
      "name": "ERP",
      "id": 548XXXXXXXXXXX771,
      "status": "active"
      },
      {
      "name": "Explore Zoho Projects!",
      "id": 5489XXXXXXXXXXX671,
      "status": "active"
      }

Related Links