Retrieve licensed software with compliance status

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

Returns the list of licensed software along with their compliance status details.

Endpoints

Request URL

https://{serverurl}/dcapi/inventory/viewData/licenseSoftware

Scope

DesktopCentralCloud.Inventory.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Query Parameters

toolIDstringMandatory

Set value as 2171

compliancestringOptional

Compliance status filter. Allowed values: 0 - Under licensed, 1 - Over licensed, 2 - In compliance, 3 - Expired, -1 - Not available

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url 'https://appdomains/dcapi/inventory/viewData/licenseSoftware?toolID=2171' \
  --header 'Accept: application/InventoryMobileAPI.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Pagination metadata

Show Sub-Attributes
limitstring

Number of items returned per page

pagestring

Current page number in paginated response

totalRecordsstring

Total number of records matching the query

messageResponseJSON Array

Array of licensed software objects

Show Sub-Attributes
JSON Object
Show Sub-Attributes
managed_installations_transformstring

Managed installations count display value

po_file_namestring

Purchase order file name

license_file_namestring

License file name

sw_type_transformstring

Software type display value

edition_namestring

Software edition name

license_ref_number_transformstring

License reference number display value

sw_category_namestring

Software category name

vendor_transformstring

Vendor display value

software_compliance_descriptionstring

Compliance description i18n key

po_file_name_transformstring

PO file name display value

display_name_transformstring

Display name display value

compliant_statusstring

Compliance status code

software_namestring

Software name

software_versionstring

Software version

software_compliance_description_transformstring

Compliance description display value

total_copies_transformstring

Total copies display value

invoice_numberstring

Invoice number

license_key_transformstring

License key display value

manufacturer_idstring

Manufacturer identifier

detected_timestring

Detection time as epoch timestamp

total_copiesstring

Total license copies

location_transformstring

Location display value

edition_name_transformstring

Edition name display value

licensed_tostring

Licensed to

license_type_transformstring

License type display value

display_namestring

Software display name

is_multiplestring

Whether multiple licenses exist

license_keystring

License key

manufacturer_name_transformstring

Manufacturer name display value

installed_copiesstring

Number of installed copies

remaining_copiesstring

Remaining license copies

license_ref_numberstring

License reference number

purchase_datestring

Purchase date as epoch timestamp

expiry_date_transformstring

Expiry date display value

po_canonical_pathstring

Purchase order canonical file path

invoice_canonical_pathstring

Invoice canonical file path

software_version_transformstring

Software version display value

invoice_file_namestring

Invoice file name

network_installations_transformstring

Network installations display value

license_file_name_transformstring

License file name display value

managed_installationsstring

Managed installations count

license_canonical_pathstring

License canonical file path

software_idstring

Software identifier

purchase_date_transformstring

Purchase date display value

po_numberstring

Purchase order number

license_edition_idstring

License edition identifier

vendorstring

Vendor name

license_metric_transformstring

License metric display value

license_ownerstring

License owner

sw_typestring

Software type code

remarks_transformstring

Remarks display value

network_installationsstring

Network installations count

license_details_idstring

License details identifier

is_usage_prohibited_transformstring

Prohibited status display value

commentsstring

Comments

coststring

License cost

license_typestring

License type

expiry_datestring

Expiry date as epoch timestamp

manufacturer_namestring

Manufacturer name

sw_category_name_transformstring

Software category display value

license_idstring

License identifier

invoice_number_transformstring

Invoice number display value

licensesubquery_license_idstring

License subquery license ID

po_number_transformstring

PO number display value

cost_transformstring

Cost display value

remaining_copies_transformstring

Remaining copies display value

invoice_file_name_transformstring

Invoice file name display value

locationstring

Location

license_metricstring

License metric

is_usage_prohibitedstring

Prohibited status code

licensed_to_transformstring

Licensed to display value

remarksstring

Remarks

totalPagesstring

Total number of pages

LinksJSON Object

Pagination links

Show Sub-Attributes
nextstring

URL to the next page of results, null if last page

prevstring

URL to the previous page of results, null if first page

statusstring

Response status - success

- HTTP code 500

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

INTERNAL_ERROR - unexpected exception in the service layer

error_descriptionstring

Internal server error message

Possible Response Codes

200HTTP code
500HTTP code

Sample Response: HTTP 200

Licensed software view

Copied!
  {
    "metadata": {
      "limit": 25,
      "page": 1
    },
    "totalRecords": "1",
    "messageResponse": [
      {
        "managed_installations_transform": "1",
        "po_file_name": "--",
        "license_file_name": "--",
        "sw_type_transform": "Commercial",
        "edition_name": null,
        "license_ref_number_transform": "--",
        "sw_category_name": null,
        "vendor_transform": "--",
        "software_compliance_description": "dc.common.OVER_LICENSED",
        "po_file_name_transform": "--",
        "display_name_transform": "Sample Software",
        "compliant_status": "1",
        "software_name": "Sample Software",
        "software_version": "24.05",
        "software_compliance_description_transform": "Over Licensed",
        "total_copies_transform": "5",
        "invoice_number": "--",
        "license_key_transform": "--",
        "manufacturer_id": "57",
        "detected_time": "1778767966690",
        "total_copies": "5",
        "location_transform": "--",
        "edition_name_transform": "--",
        "licensed_to": "--",
        "license_type_transform": "--",
        "display_name": "Sample Software",
        "is_multiple": "false",
        "license_key": "--",
        "manufacturer_name_transform": "Sample Manufacturer",
        "installed_copies": "1",
        "remaining_copies": "4",
        "license_ref_number": "--",
        "purchase_date": "0",
        "expiry_date_transform": "--",
        "po_canonical_path": "--",
        "invoice_canonical_path": "--",
        "software_version_transform": "24.05",
        "invoice_file_name": "--",
        "network_installations_transform": "1",
        "license_file_name_transform": "--",
        "managed_installations": "1",
        "license_canonical_path": "--",
        "software_id": "51",
        "purchase_date_transform": "--",
        "po_number": "--",
        "license_edition_id": null,
        "vendor": "--",
        "license_metric_transform": "--",
        "license_owner": "--",
        "sw_type": "1",
        "remarks_transform": "--",
        "network_installations": "1",
        "license_details_id": "1",
        "is_usage_prohibited_transform": "Prohibited",
        "comments": null,
        "cost": null,
        "license_type": null,
        "expiry_date": "0",
        "manufacturer_name": "Sample Manufacturer",
        "sw_category_name_transform": "Not Assigned",
        "license_id": "1",
        "invoice_number_transform": "--",
        "licensesubquery_license_id": "1",
        "po_number_transform": "--",
        "cost_transform": "--",
        "remaining_copies_transform": "4",
        "invoice_file_name_transform": "--",
        "location": "--",
        "license_metric": null,
        "is_usage_prohibited": "2",
        "licensed_to_transform": "--",
        "remarks": "--"
      }
    ],
    "totalPages": 1,
    "Links": {
      "next": null,
      "prev": null
    },
    "status": "success"
  }
▼ Show full

Sample Response: HTTP 500

Server error

Copied!
  {
    "error_description": "Internal server error",
    "error_code": "INTERNAL_ERROR"
  }
▼ 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.

© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.