Find claim keys by client org

curl --request POST \
  --url https://api2.rhombussystems.com/api/license/claimkey/findClaimKeysByClientOrg \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "claimKeySearchFilter": {
    "excludeUnclaimed": true,
    "excludedStates": [],
    "includedStates": []
  },
  "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'

import requests

url = "https://api2.rhombussystems.com/api/license/claimkey/findClaimKeysByClientOrg"

payload = {
    "claimKeySearchFilter": {
        "excludeUnclaimed": True,
        "excludedStates": [],
        "includedStates": []
    },
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
headers = {
    "x-auth-scheme": "<x-auth-scheme>",
    "x-auth-apikey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-auth-scheme': '<x-auth-scheme>',
    'x-auth-apikey': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    claimKeySearchFilter: {excludeUnclaimed: true, excludedStates: [], includedStates: []},
    orgUuid: 'AAAAAAAAAAAAAAAAAAAAAA'
  })
};

fetch('https://api2.rhombussystems.com/api/license/claimkey/findClaimKeysByClientOrg', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/license/claimkey/findClaimKeysByClientOrg")
  .header("x-auth-scheme", "<x-auth-scheme>")
  .header("x-auth-apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"claimKeySearchFilter\": {\n    \"excludeUnclaimed\": true,\n    \"excludedStates\": [],\n    \"includedStates\": []\n  },\n  \"orgUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\"\n}")
  .asString();

{
  "claimKeys": [
    {
      "claimEndDate": "2023-11-07T05:31:56Z",
      "claimStartDate": "2023-11-07T05:31:56Z",
      "createdOn": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "gracePeriodEndDate": "2023-11-07T05:31:56Z",
      "maskedClaimCode": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "renewedByClaimKeyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "requestId": "<string>",
      "returnHistory": [
        {
          "returnedProductQuantities": {},
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ],
      "trial": true,
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

ClaimKey Webservice

Find claim keys by client org

Find the claim keys claimed by the specified client organization, optionally filtered by state. The caller must be a partner with license administration access to the client organization. Each claim key carries the term of one purchase: startDate and endDate are the term boundaries and gracePeriodEndDate is 30 days past endDate. Note that claimStartDate and claimEndDate are when the key was redeemed, not term boundaries, and that only claim keys of type NEW carry a startDate - a RENEWAL key extends the terms it renews and carries only an endDate. When filtering by state, note that a key past its endDate but inside its grace period has state EXPIRED, and a renewed key moves to RENEWED while its successor RENEWAL key carries the extended term - filtering to CLAIMED alone hides such coverage. To assess coverage, prefer excludeUnclaimed: true and compare endDate/gracePeriodEndDate per key. Client organizations that have not been migrated to the current licensing model hold no claim keys and get an empty list.

POST

api

license

claimkey

findClaimKeysByClientOrg

Find claim keys by client org

curl --request POST \
  --url https://api2.rhombussystems.com/api/license/claimkey/findClaimKeysByClientOrg \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "claimKeySearchFilter": {
    "excludeUnclaimed": true,
    "excludedStates": [],
    "includedStates": []
  },
  "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'

import requests

url = "https://api2.rhombussystems.com/api/license/claimkey/findClaimKeysByClientOrg"

payload = {
    "claimKeySearchFilter": {
        "excludeUnclaimed": True,
        "excludedStates": [],
        "includedStates": []
    },
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
headers = {
    "x-auth-scheme": "<x-auth-scheme>",
    "x-auth-apikey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-auth-scheme': '<x-auth-scheme>',
    'x-auth-apikey': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    claimKeySearchFilter: {excludeUnclaimed: true, excludedStates: [], includedStates: []},
    orgUuid: 'AAAAAAAAAAAAAAAAAAAAAA'
  })
};

fetch('https://api2.rhombussystems.com/api/license/claimkey/findClaimKeysByClientOrg', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/license/claimkey/findClaimKeysByClientOrg")
  .header("x-auth-scheme", "<x-auth-scheme>")
  .header("x-auth-apikey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"claimKeySearchFilter\": {\n    \"excludeUnclaimed\": true,\n    \"excludedStates\": [],\n    \"includedStates\": []\n  },\n  \"orgUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\"\n}")
  .asString();

{
  "claimKeys": [
    {
      "claimEndDate": "2023-11-07T05:31:56Z",
      "claimStartDate": "2023-11-07T05:31:56Z",
      "createdOn": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "gracePeriodEndDate": "2023-11-07T05:31:56Z",
      "maskedClaimCode": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "renewedByClaimKeyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "requestId": "<string>",
      "returnHistory": [
        {
          "returnedProductQuantities": {},
          "timestamp": "2023-11-07T05:31:56Z"
        }
      ],
      "trial": true,
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

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:partner-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

claimKeySearchFilter

object

Show child attributes

orgUuid

string<RUUID> | null

RUUID

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

claimKeys

object[] | null

Show child attributes

error

boolean | null

errorMsg

string | null

warningMsg

string | null

Last modified on August 17, 2026