Retrieves a paginated list of Automated Patch Deployment tasks with their configuration details, target counts, and schedule information.
This API endpoint is deprecating soon
View new endpoint >get /api/1.4/patch/apdTaskListdetails
https://{serverurl}/api/1.4/patch/apdTaskListdetails Copied!
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
curl --request GET \
--url https://appdomains/api/1.4/patch/apdTaskListdetails \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Action identifier: apdTaskListdetails
APD task list response payload with pagination
Total number of APD tasks
Array of APD task detail objects
APD task name
Unique task identifier
Associated collection/group ID
Collection status (2=active)
Task type identifier (18=APD task)
Target platform display name: Windows, Mac, or Linux
Platform numeric ID: 1=Windows, 2=Mac, 3=Linux
Number of target computers
User ID who created the task
First name of the user who created the task
Task creation timestamp in epoch milliseconds
Last modification timestamp in epoch milliseconds
Scheduler class ID or -- if not scheduled
Deployment template ID or -- if not assigned
Remarks or collection ID reference
Records per page
Current page number
API version: 1.3
Overall operation status: success
Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
Authentication failure reason
Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)
Message indicating insufficient privileges to access this resource
Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes
Rate limit exceeded message with retry guidance
{
"message_type": "apdTaskListdetails",
"message_response": {
"total": 2,
"apdtasklistdetails": [
{
"task_name": "MyTask1",
"total_target": "1",
"task_id": "633",
"os_platform_name": "Windows",
"collection_id": "312",
"collection_status": "2",
"user_id": "1",
"task_modified_time": "1756191374069",
"scheduler_class_id": "--",
"template_id": "--",
"task_type": "18",
"task_creation_time": "1756191374069",
"first_name": "admin",
"os_platform_id": "1",
"remarks": "312"
},
{
"task_name": "MyTask2",
"total_target": "--",
"task_id": "635",
"os_platform_name": "Windows",
"collection_id": "313",
"collection_status": "2",
"user_id": "1",
"task_modified_time": "1756191413366",
"scheduler_class_id": "--",
"template_id": "--",
"task_type": "18",
"task_creation_time": "1756191413366",
"first_name": "admin",
"os_platform_id": "1",
"remarks": "313"
}
],
"limit": 25,
"page": 1
},
"message_version": "1.3",
"status": "success"
}
Authentication credentials are missing, expired or invalid
{
"error_code": "UAC_UNAUTHORIZED",
"error_description": "dc.rest.authentication.unauthorized"
}
Authenticated user lacks the required role or scope
{
"errorCode": "FORBIDDEN",
"errorMessage": "You do not have sufficient privileges to perform this operation"
}
API call threshold exceeded
{
"errorCode": "RATE_LIMIT_EXCEEDED",
"errorMessage": "API call limit exceeded. Retry after the lock period elapses"
}
![]()
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.