Claim Keys

Find claim keys by org

Find the claim keys belonging to the authenticated organization, optionally filtered by state. Each claim key carries the term of one purchase, so this is how license term start/end dates are read programmatically. See getClaimKey for how to read the term fields. 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. Organizations that have not been migrated to the current licensing model hold no claim keys and get an empty list.

POST/api/license/claimkey/findClaimKeysByOrg

Authorizations

x-auth-apikeystringheaderrequired

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

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

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

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

claimKeySearchFilterobjectbody

Show child attributes

excludeUnclaimedboolean | nullbody

excludedStatesenum<string>[] | nullbody

includedStatesenum<string>[] | nullbody

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/license/claimkey/findClaimKeysByOrg' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "claimKeySearchFilter": {
      "excludeUnclaimed": true,
      "excludedStates": [
        "CREATED"
      ],
      "includedStates": [
        "CREATED"
      ]
    }
  }'

import requests

url = "https://api2.rhombussystems.com/api/license/claimkey/findClaimKeysByOrg"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "claimKeySearchFilter": {
        "excludeUnclaimed": True,
        "excludedStates": [
            "CREATED"
        ],
        "includedStates": [
            "CREATED"
        ]
    }
}

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

const response = await fetch('https://api2.rhombussystems.com/api/license/claimkey/findClaimKeysByOrg', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "claimKeySearchFilter": {
      "excludeUnclaimed": true,
      "excludedStates": [
        "CREATED"
      ],
      "includedStates": [
        "CREATED"
      ]
    }
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "claimKeySearchFilter": {
                "excludeUnclaimed": true,
                "excludedStates": [
                  "CREATED"
                ],
                "includedStates": [
                  "CREATED"
                ]
              }
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/license/claimkey/findClaimKeysByOrg"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "claimKeys": [
    {
      "claimEndDate": "2026-01-01T00:00:00Z",
      "claimStartDate": "2026-01-01T00:00:00Z",
      "createdOn": "2026-01-01T00:00:00Z",
      "endDate": "2026-01-01T00:00:00Z",
      "expirationEmailState": "NINETY_DAY_EMAIL_SUCCEEDED",
      "gracePeriodEndDate": "2026-01-01T00:00:00Z",
      "maskedClaimCode": "<string>",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "ownerOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "renewedByClaimKeyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "requestId": "<string>",
      "returnHistory": [
        {
          "returnedProductQuantities": {},
          "timestamp": "2026-01-01T00:00:00Z"
        }
      ],
      "state": "CREATED",
      "trial": true,
      "type": "NEW",
      "updatedOn": "2026-01-01T00:00:00Z",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ],
  "error": false,
  "errorCode": "<string>"
}

Response

200 OK

application/json · object

claimKeysobject[] | null

Show child attributes

claimEndDatestring<date-time> | null

Date/time when claiming of licenses represented by this claim key ended successfully.

claimStartDatestring<date-time> | null

Date/time when claiming of licenses represented by this claim key started.

createdOnstring<date-time> | null

endDatestring<date-time> | null

expirationEmailStateenum<string>

Available options: NINETY_DAY_EMAIL_SUCCEEDED, NINETY_DAY_EMAIL_FAILED, SIXTY_DAY_EMAIL_SUCCEEDED, SIXTY_DAY_EMAIL_FAILED, FOURTY_FIVE_DAY_EMAIL_SUCCEEDED, FOURTY_FIVE_DAY_EMAIL_FAILED, THIRTY_DAY_EMAIL_SUCCEEDED, THIRTY_DAY_EMAIL_FAILED, TWENTY_ONE_DAY_EMAIL_SUCCEEDED, TWENTY_ONE_DAY_EMAIL_FAILED, FOURTEEN_DAY_EMAIL_SUCCEEDED, FOURTEEN_DAY_EMAIL_FAILED, TEN_DAY_EMAIL_SUCCEEDED, TEN_DAY_EMAIL_FAILED, SEVEN_DAY_EMAIL_SUCCEEDED, SEVEN_DAY_EMAIL_FAILED, FIVE_DAY_EMAIL_SUCCEEDED, FIVE_DAY_EMAIL_FAILED, FOUR_DAY_EMAIL_SUCCEEDED, FOUR_DAY_EMAIL_FAILED, THREE_DAY_EMAIL_SUCCEEDED, THREE_DAY_EMAIL_FAILED, TWO_DAY_EMAIL_SUCCEEDED, TWO_DAY_EMAIL_FAILED, ONE_DAY_EMAIL_SUCCEEDED, ONE_DAY_EMAIL_FAILED, ZERO_DAY_EMAIL_SUCCEEDED, ZERO_DAY_EMAIL_FAILED, GRACE_PERIOD_EMAILS_IN_PROGRESS, GRACE_PERIOD_EMAILS_COMPLETED, UNKNOWN

gracePeriodEndDatestring<date-time> | null

maskedClaimCodestring | null

Masked claim code for redeemed claim keys. This field can be used for reference purposes.

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerOrgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

renewedByClaimKeyUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

requestIdstring | null

Externally supplied request id to prevent creation of unnecessary claim keys due to reprocessing or bugs. Unnecessary claim keys are claim keys that are not tied to anything in the external system. This property is unique for all claim keys.

returnHistoryobject[] | null

Show child attributes

returnedProductQuantitiesobject | null

timestampstring<date-time> | null

stateenum<string>

Available options: CREATED, CLAIMING_PENDING, CLAIMING_IN_PROGRESS, CLAIMING_FAILED, CLAIMED, EXPIRED_UNCLAIMED, EXPIRED, RETURNED, RENEWED

trialboolean | null

typeenum<string>

Available options: NEW, RENEWAL

updatedOnstring<date-time> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

errorboolean | null

errorCodestring | null

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring | null

warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.