Retrieve AD sync status for a domain

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Retrieves the AD synchronization status and last sync details for a specific domain including next sync time, last succeeded sync, and error information.

Request URL

https://{serverurl}/dcapi/som/domains/{domain_id}/syncStatus

Scope

DesktopCentralCloud.SOM.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/domainTreeSyncStatus.v1+jsonapplication/domainTreeSyncStatus.v1+jsonCopied!

- Path Parameters

domain_idstringMandatory

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/som/domains/{domain_id}/syncStatus \
  --header 'Accept: application/domainTreeSyncStatus.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
isDomainSyncInProgressboolean

Indicates whether an Active Directory synchronization is currently running for this domain

resourceIdlong

Unique resource identifier of the domain being synced

nextSyncTimestring

Scheduled date and time for the next automatic synchronization (formatted as 'yyyy-MM-dd HH:mm:ss')

lastSyncInitiatedstring

Date and time when the most recent synchronization was initiated (formatted as 'yyyy-MM-dd HH:mm:ss')

lastSuccessfulSyncstring

Date and time of the last synchronization that completed without errors (formatted as 'yyyy-MM-dd HH:mm:ss')

isUpdateSuccessboolean

Indicates whether the most recent synchronization completed successfully without errors

errorCodestring

Error code identifying the synchronization failure. Present only when the last sync failed

messagestring

Detailed error description explaining why the synchronization failed. Present only when the last sync failed

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

No sync running

Copied!
  {
    "resourceId": 1,
    "nextSyncTime": "2026-04-08 14:00:00",
    "isUpdateSuccess": true,
    "isDomainSyncInProgress": false,
    "lastSyncInitiated": "2026-04-08 08:00:00",
    "lastSuccessfulSync": "2026-04-08 08:02:30"
  }
                
Show full

Sync is running

Copied!
  {
    "resourceId": 1,
    "nextSyncTime": "2026-04-08 20:00:00",
    "isDomainSyncInProgress": true,
    "lastSyncInitiated": "2026-04-08 14:00:00",
    "lastSuccessfulSync": "2026-04-08 08:02:30"
  }
                
Show full

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.