Licenses

Accessing Customer License Records

Get

Roles: Administrator, Sales

The GET method on the Licenses endpoint, nested under the Customers section, is crucial for obtaining comprehensive information about the licenses associated with a particular customer. This endpoint provides a detailed overview of all licenses held by a customer, including their types, validity periods, and any specific terms or conditions. This function is essential for monitoring and managing customer-specific licensing arrangements, ensuring compliance with licensing agreements, and understanding the customer's usage and access patterns.

Retrieves a list of licenses for a specific customer.

GET/v1/customers/{customerId}/licenses

Path parameters

customerId*integer (int32)

customer_id is the ID of the customer.

Query parameters

Response

200default

Success

Body

application/json

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

licensesarray of License (object)

licenses is the list of licenses.

totalLicensesCountinteger (int32)

total_licenses_count is the total number of licenses.

Request

JavaScriptCurl

const response = await fetch('/v1/customers/{customerId}/licenses', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "licenses": [
    {
      "licenseId": "text",
      "licenseType": "text",
      "format": "Xml",
      "description": "text",
      "issueDate": "text",
      "expireDate": "text",
      "supportExpireDate": "text",
      "revoked": false,
      "licenseKey": "text",
      "userKey": "text",
      "licensingMode": "File",
      "hash": "text",
      "product": {
        "id": "text",
        "name": "text",
        "version": "text",
        "copyright": "text",
        "url": "text",
        "description": "text"
      },
      "licensee": {
        "name": "text",
        "company": "text",
        "contactInfo": "text",
        "url": "text"
      },
      "components": [
        "text"
      ],
      "assemblies": [
        {
          "name": "text",
          "version": "text",
          "culture": "text",
          "publicKeyToken": "text",
          "debugSymbolsKey": "text"
        }
      ],
      "fields": [
        {
          "name": "text",
          "value": "text"
        }
      ],
      "features": [
        {
          "id": "text",
          "name": "text",
          "description": "text",
          "expireDate": "text",
          "key": "text",
          "data": "text"
        }
      ],
      "restrictions": [
        {
          "id": "text",
          "name": "text",
          "expireDate": "text"
        }
      ]
    }
  ]
}