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

Authorizations

Path parameters

customerIdinteger · int32Required

customer_id is the ID of the customer.

Query parameters

selectstringOptional

filterstringOptional

sortstringOptional

takeinteger · int32Optional

skipinteger · int32Optional

Responses

application/json

objectOptional

GetCustomerLicensesResponse is the response message for the GetCustomerLicensesRequest.

application/json

get

HTTPcURLJavaScriptPython

GET /v1/customers/{customerId}/licenses HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "licenses": [
    {
      "id": 1,
      "licenseId": "text",
      "licenseType": "text",
      "format": "Xml",
      "description": "text",
      "issueDate": "text",
      "expireDate": "text",
      "supportExpireDate": "text",
      "revoked": true,
      "licenseKey": "text",
      "maxAllowedSites": 1,
      "userKey": "text",
      "licensingMode": "File",
      "hash": "text",
      "templateId": 1,
      "signatureKeysId": 1,
      "customerId": 1,
      "orderId": 1,
      "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": [
        {
          "id": 1,
          "name": "text",
          "version": "text",
          "culture": "text",
          "publicKeyToken": "text",
          "mappingFileId": 1,
          "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",
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        }
      ]
    }
  ],
  "totalLicensesCount": 1
}