# Retrieve licensed software with compliance status

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

## Endpoint

`GET /dcapi/inventory/viewData/licenseSoftware`

## Request URL

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

## Scope

`DesktopCentralCloud.Inventory.READ`

## Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Request Headers

| Parameter | Type | Required | Value |
|---|---|---|---|
| Accept | string | Mandatory | `application/InventoryMobileAPI.v1+json` |

### Query Parameters

| Parameter | Type | Required | Description |
|---|---|---|---|
| toolID | string | Mandatory | Set value as `2171` |
| compliance | string | Optional | Compliance status filter. Allowed values: `0` - Under licensed, `1` - Over licensed, `2` - In compliance, `3` - Expired, `-1` - Not available |

## Sample Request

### Curl

```curl
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`

| Parameter | Type | Description |
|---|---|---|
| Response body | JSON Object |  |
| metadata | JSON Object | Pagination metadata |
| totalRecords | string | Total number of records matching the query |
| messageResponse | JSON Array | Array of licensed software objects |
| totalPages | string | Total number of pages |
| Links | JSON Object | Pagination links |
| status | string | Response status - success |

### HTTP Code 500

Response Body: `application/json`

| Parameter | Type | Description |
|---|---|---|
| Response body | JSON Object |  |
| error_code | string | INTERNAL_ERROR - unexpected exception in the service layer |
| error_description | string | Internal server error message |

## Possible Response Codes

| Code | Type |
|---|---|
| 200 | HTTP code |
| 500 | HTTP code |

## Sample Response: HTTP 200

Licensed software view

```json
{
  "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"
}
```

## Sample Response: HTTP 500

Server error

```json
{
  "error_description": "Internal server error",
  "error_code": "INTERNAL_ERROR"
}
```

## Rate Limit

![ ](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

**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.