Skip to main content
POST
/
api
/
license
/
getLicenses
Get licenses
curl --request POST \
  --url https://api2.rhombussystems.com/api/license/getLicenses \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '{}'
{
  "error": true,
  "errorMsg": "<string>",
  "licenses": [
    {
      "additionalPerceptionFeatures": [],
      "claimKeyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "cloudArchiveDays": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "firstAssignedDate": "2023-11-07T05:31:56Z",
      "maxDeleteDate": "2023-11-07T05:31:56Z",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "perceptionTypes": [],
      "priorClaimKeyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "productCode": "<string>",
      "trial": true,
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "warningMsg": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://api-docs.rhombus.community/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

x-auth-apikey
string
header
required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme
enum<string>
default:api-token
required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options:
api-token,
api,
partner-api-token,
partner-api

Body

application/json

Request object for getting list of add-on 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 add-on licenses available in organization.

error
boolean | null
errorMsg
string | null
licenses
object[] | null

List of add-on licenses available in the organization

warningMsg
string | null
Last modified on May 23, 2026