Skip to main content
POST
/
api
/
license
/
getDeviceLicenses
Get device licenses
curl --request POST \
  --url https://api2.rhombussystems.com/api/license/getDeviceLicenses \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "optionalDeviceTypeFilter": "BLE_TRACKER"
}
'
{
  "deviceLicenses": [
    {
      "claimKeyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "createdOn": "2023-11-07T05:31:56Z",
      "deviceType": "BLE_TRACKER",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "features": [
        {
          "enabled": true,
          "name": "<string>"
        }
      ],
      "firstAssignedDate": "2023-11-07T05:31:56Z",
      "licenseFamily": "CAMERA",
      "licenseToUnassignEmailState": "INITIAL_EMAIL_SUCCEEDED",
      "licenseType": "STARTER",
      "maxDeleteDate": "2023-11-07T05:31:56Z",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "priorClaimKeyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "productCode": "<string>",
      "productType": "DEVICE",
      "state": "CLAIMED",
      "trial": true,
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for getting list of device licenses available in organization.

optionalDeviceTypeFilter
enum<string>
Available options:
BLE_TRACKER,
CAMERA,
DOOR_SENSOR,
ENVIRONMENTAL_SENSOR,
OCCUPANCY_SENSOR,
AUDIO_GATEWAY,
EXECUTABLE,
BADGE_READER,
DOOR_CONTROLLER,
BLE_BUTTON,
IO_BOARD,
ENVIRONMENTAL_GATEWAY,
NVR,
ROBOT,
UNKNOWN

Response

200 - application/json

OK

Response object containing list of device licenses available in organization.

deviceLicenses
object[] | null

List of device licenses available in the organization

error
boolean | null
errorMsg
string | null
warningMsg
string | null