List all reseller licenses

Returns a list of reseller licenses. The reseller licenses are returned sorted by creation date in ascending order.

GET/v3/resellers/{resellerId}/licenses
JWT
reseller:license:read

Parameters

NameTypeInDescription
resellerId*stringpath
pageintegerqueryThe page number.
limitintegerqueryThe number of records per page. Must be a number between 1 and 100.
sortstringqueryThe sort string to sort the returned records e.g. "-createdAt"
userIdstringqueryUnique identifier for the user. A user is associated with a license directly, via a user group, or through the additionalUserIds property.
organizationIdobjectqueryUnique identifier for the organization.
activation.lastSyncedAtobjectqueryThe last synced at date of the activation linked to the license.
product.displayNameobjectqueryProduct Associated with the license.
productVersion.displayNameobjectqueryProduct Version associated with the license.
keyobjectqueryThe key associated with the license.
revokedbooleanqueryWhether a license is revoked.
suspendedbooleanqueryWhether a license is suspended.
typeobjectqueryType of the license.
validityobjectqueryThe duration after which the license will expire.
subscriptionIntervalobjectquerySubscription interval for the license.
allowedActivationsobjectqueryAllowed number of activations for the license.
allowedDeactivationsobjectqueryAllowed number of deactivations for the license.
totalActivationsobjectqueryTotal number of activations for the license.
totalDeactivationsobjectqueryTotal number of deactivations for the license.
notesobjectqueryThe license notes.
metadata.keyobjectqueryMetadata key associated with the license.
metadata.valueobjectqueryMetadata value associated with the license.
expiresAtobjectqueryLicenses expiring at.
expiredbooleanqueryWhether license is expired.
perpetualbooleanqueryWhether license is perpetual.
entitlementSetIdobjectqueryID of the linked entitlement set.
searchstringquerySearch string.
idobjectqueryID of the resource.
createdAtobjectqueryDate of creation
updatedAtobjectqueryDate of last update

Responses

200 OK
[
  {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "key": "string",
    "revoked": true,
    "suspended": true,
    "perpetual": true,
    "type": "node-locked",
    "validity": 0,
    "subscriptionInterval": "string",
    "totalActivations": 0,
    "totalDeactivations": 0,
    "allowedActivations": 0,
    "allowedDeactivations": 0,
    "allowedFloatingClients": 0,
    "leaseDuration": 0,
    "expiresAt": "2019-08-24T14:15:22Z",
    "effectiveDate": "2019-08-24T14:15:22Z",
    "notes": "string",
    "metadata": [
      {
        "id": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "key": "string",
        "value": "string"
      }
    ],
    "meterAttributes": [
      {
        "id": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "name": "string",
        "allowedUses": 0,
        "totalUses": 0,
        "grossUses": 0,
        "floating": true
      }
    ],
    "product": {
      "id": "string",
      "displayName": "string",
      "iconUrl": "string",
      "description": "string"
    },
    "productVersion": {
      "displayName": "string"
    },
    "entitlementSet": {
      "name": "string"
    },
    "userId": "string",
    "user": {
      "id": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "role": "string",
      "twoFactorEnabled": true,
      "googleSsoEnabled": true,
      "lastLoginAt": "2019-08-24T14:15:22Z",
      "organizationId": "string",
      "organization": {
        "id": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "name": "string",
        "email": "string",
        "description": "string",
        "allowedUsers": 0,
        "address": {
          "addressLine1": "string",
          "addressLine2": "string",
          "city": "string",
          "state": "string",
          "country": "string",
          "postalCode": "string"
        }
      },
      "company": "string"
    },
    "organizationId": "string",
    "organization": {
      "id": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "name": "string",
      "email": "string",
      "description": "string",
      "allowedUsers": 0,
      "address": {
        "addressLine1": "string",
        "addressLine2": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "postalCode": "string"
      }
    }
  }
]