Portals API

Scope: ZohoProjects.portals.{Operation}

Operation: READ

 All Portals

Gets all the portals for the logged in user.

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8

{
  "login_id": "639283127",
  "portals": [
    {
      "trial_enabled": false,
      "gmt_time_zone": "(GMT 0:0) Irish Summer Time",
      "project_count": {
        "active": 2
      },
      "role": "admin",
      "avail_user_count": 0,
      "is_crm_partner": false,
      "link": {
        "project": {
          "url": "https://projectsapi.zoho.com/restapi/portal/647154632/projects/"
        }
      },
 "new_user_plan": true,
      "available_projects": 0,
      "default": false,
      "id": 680404658,
      "bug_plural": "Issues",
      "is_new_plan": false,
      "plan": "Free",
      "settings": {
        "business_hours": {
          "business_end": 1440,
          "business_start": 0
        },
  "default_dependency_type": "finish-start",
        "working_days": [
          "Sunday",
          "Monday",
          "Tuesday",
          "Wednesday",
          "Thursday",
          "Friday",
          "Saturday"
        ],
        "timelog_period": {
          "log_future_time": {
            "allowed": false
          },
          "log_past_time": {
            "allowed": true
          }
        },
}]
}}

 Portal Details

Lists the details of a particular portal.

Sample Response

Status: 200 Success

Content Type: application/json;charset=utf-8

      "is_display_taskprefix": true,
      "bug_singular": "Issue",
      "is_display_projectprefix": true,
      "project_prefix": "ZY-",
      "max_user_count": 10,
      "extensions": {
        "locations": {
          "app_settings": "1103053000000031009",
          "issue_tab": "1103053000000031013",
          "task_tab": "1103053000000031011"
        }
      },
      "profile_id": 1103053000000017200,
      "name": "zylkerevents",
      "id_string": "647154632"
    }
  ]
}

Schedule Portal Data Backup

This API schedules a new portal data backup. If a backup for the portal already exists, the API will return the existing backup. The user will receive a link to download a .zip file containing separate CSV files for each module.

Sample Response

Invoking this API will successfully schedule a portal data backup. The backup will run in the background and the download URL will be provided in a subsequent response.

{
  "status_code": 202,
  "details": {
    "message": "PORTAL_EXPORT_SCHEDULED"
  },
  "download_api_url": "https://projectsapi.zoho.com/api/v3/portal/74014703/portal_export/1409060001/download"
}

Note:

• This API can only be accessed by the portal owner.

• Data export can be scheduled once every 24 hours. If attempted more than once, it will return the latest existing backup.

Download Portal Data Backup

This API downloads a portal data backup that has been previously scheduled. The user will get a link to return a .zip file with a separate CSV file for each module.

Sample Response

Calling this API will return a backup file if the data backup schedule has been completed. You will receive the following response if the backup is not completed.

{
  "status_code": 202,
  "details": {
    "message": "PORTAL_EXPORT_IN_PROGRESS"
  }
}