Returns the list of tool deployment configurations (System Tools, Shutdown, WOL, Announcement) that target the specified custom group, identified by the 'customGroupId' query parameter.
get /dcapi/tools/cgDeployments
https://{serverurl}/dcapi/tools/cgDeployments
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Unique ID of the custom group to retrieve tool deployment configurations for. Required
curl --request GET \
--url 'https://appdomains/dcapi/tools/cgDeployments?customGroupId=SOME_INTEGER_VALUE' \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Array of deployment objects with deploymentType, taskName, taskId, and status for each tool targeting the specified custom group
{
"deployments": [
{
"deploymentType": "SystemTools",
"taskName": "Weekly Cleanup",
"taskId": 12,
"status": "Active"
},
{
"deploymentType": "Shutdown",
"taskName": "Nightly Shutdown",
"taskId": 5,
"status": "Active"
}
]
}
![]()
Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes
Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.