Get list of available engages
get /intelligence/sensors/api/getEngages
https://{serverurl}/intelligence/sensors/api/getEngages
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Optional comma-separated engage IDs (e.g., 1001,1002). Omit to retrieve all engages
curl --request GET \
--url https://appdomains/intelligence/sensors/api/getEngages \
--header 'Accept: application/engages.v1+json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Name of the engage
Display label
Description of what the engage does
List of questions shown to the user
Question text displayed to the user
Map of option IDs to option labels (e.g., {'501': 'Yes', '502': 'Later'})
Default selected option label
Question type identifier
Unique identifier of the question
Sender details shown to the recipient
Sender display name (e.g., 'IT Ops')
Sender role (e.g., 'Administrator')
Message shown after the user completes the engage
Time limit in minutes for the user to respond
Error code for the server error
Details about the error
Single engage definition with questions and sender info
{
"1001": {
"senderInfo": {
"role": "Administrator",
"name": "IT Ops"
},
"endMessage": "Thank you",
"name": "Patch Feedback",
"questions": [
{
"questionID": "9001",
"question": "Can we reboot now?",
"options": {
"501": "Yes",
"502": "Later"
},
"defaultOption": "Later",
"type": 2
}
],
"description": "Collect user confirmation",
"label": "Patch Prompt",
"timeout": 30
}
}
Server error while loading engages
{
"errorMessage": "An internal error occurred while fetching engage details.",
"errorCode": "INTERNAL_ERROR_WITH_CUSTOM_MSG"
}
![]()
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.