Returns a paginated list of customers in MSP deployments

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

Used to get the customer list data

Request URL

https://{serverurl}/intelligence/api/targets/deploymentCustomers

Scope

DesktopCentralCloud.DEX.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Query Parameters

offsetlongOptional

Page offset for pagination (0-based, default: 0)

limitlongOptional

Maximum number of results per page (default: 50)

searchstringOptional

Optional search filter applied to customer names

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/intelligence/api/targets/deploymentCustomers \
  --header 'Accept: application/deploymentCustomers.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
customersJSON Array

Empty customer list returned for single-tenant deployments

Show Sub-Attributes
JSON Object
Show Sub-Attributes
customerIDinteger

Customer identifier

customerNamestring

Customer display name

Possible Response Codes

200HTTP code

Single-tenant deployment

Sample Response: HTTP 200

Copied!
  {
    "customers": []
  }
                
Show full

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.