The Server Properties API provides information about the configuration of the Endpoint Central server. It returns the list of branch offices, domains, and custom groups available in the server environment. This information can be used to identify organizational structures, group policies, and domain settings.
get /api/1.4/desktop/serverproperties
https://{serverurl}/api/1.4/desktop/serverproperties Copied!
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
{resource_id} - Unique identifier of the computer
Filter computer with particular resource id
Get domain list from api/1.4/desktop/serverproperties
Get branch office list from api/1.4/desktop/serverproperties
Get custom group list from api/1.4/desktop/serverproperties
1 - Live: System is working.
2 - Down: System is not working.
3 - Unknown: System status is not known.
{resid} - Unique identifier of the computer
21: Yet to install (agent has not been installed).
22: Installed (agent is currently installed).
23: Uninstalled (agent has been removed).
24: Yet to uninstall (marked for uninstallation but not yet removed).
29: Installation failure (an error occurred during installation).
1: Commercial (used for business or paid purposes).
2: Non-commercial (used for personal or educational purposes).
0: Unidentified (license type not specified).
-1: Not done scan has not started.
0: Failed scan failed.
1: In progress scan is ongoing.
2: Success scan completed successfully.
1: Allowed (access is permitted).
2: Prohibited (access is restricted).
0: Not assigned (no access configuration).
0: Under licensed (fewer licenses than required).
1: Over licensed (more licenses than needed).
2: In compliance (license usage matches availability).
3: Expired (license validity has ended).
-1: Not available (compliance data is missing).
32-bit: For 32-bit operating systems.
64-bit: For 64-bit operating systems.
Yes: Supports uninstallation.
No: Does not support uninstallation.
MSI: Installed via MSI installer.
EXE: Installed via EXE installer.
Get License List from api/1.4/inventory/licenses?swid={softwareID} in license_id parameter inside message response
Get hardware type list from api/1.4/inventory/filterparams
Get hardware manufacturer list from api/1.4/inventory/filterparams
unique identifier of the prohibited software
curl --request GET \
--url https://appdomains/api/1.4/desktop/serverproperties \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Wrapper object containing the actual response data.
Contains server discovery details.
Lists the branch offices managed by the server.
Lists the domains managed by the server.
Lists the custom groups configured in the server.
Response status success/failure.
Version of the response message format.
Identifies the type of message
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
INTERNAL_ERROR - unexpected exception while collecting server properties
Internal server error message for server properties retrieval failures
{
"message_response": {
"serverproperties": {
"branch_offices": [
"Direct Comm",
"Intern Ds Remote",
"Local Office"
],
"domains": [
"ZOHOCORP",
"DESKTOPCENTRAL",
"WORKGROUP",
"macosgroup"
],
"custom_groups": [
"All Computers Group",
"All Users Group",
"Default_iOS_Corporate",
"Default_iOS_Personal",
"Default_Android_Corporate",
"Default_Android_Personal",
"Default_Windows_Corporate",
"Default_Windows_Personal",
"Inactive_Users_ZOHOCORP",
"Inactive_Computers_ZOHOCORP",
"test",
"sathish"
]
}
},
"message_type": "discover",
"message_version": "1.0",
"status": "success"
}
Missing or invalid authentication details
{
"errorCode": "UAC_UNAUTHORIZED",
"message": "Unauthorized access",
"statusCode": 401
}
User lacks permission to access server properties
{
"errorCode": "FORBIDDEN",
"message": "Insufficient privileges to access this resource",
"statusCode": 403
}
Too many requests sent within the throttle window
{
"errorCode": "RATE_LIMIT_EXCEEDED",
"message": "Too many requests. Please retry after some time",
"statusCode": 429
}
Unexpected server-side failure while fetching server properties
{
"error_description": "Internal server error while retrieving server properties",
"error_code": "INTERNAL_ERROR"
}
![]()
Duration: 1 minute | Threshold: 120 | 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.