Partner

Get client summaries

Get the list-row summary (device status, recent alert count, license flags and license totals) of up to 50 clients in one call. Use this for a page of the client list in place of one getClientSummaryInfo call for each client.

POST/api/partner/getClientSummaries

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

Request object for getting the summaries of several client organizations in one call.

clientOrgUuidsstring<RUUID>[] | nullbody

UUIDs of the client organizations to get summaries for. Between 1 and 50.

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/partner/getClientSummaries' \
  --header 'x-auth-scheme: partner-api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "clientOrgUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ]
  }'

import requests

url = "https://api2.rhombussystems.com/api/partner/getClientSummaries"
headers = {
    "x-auth-scheme": "partner-api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "clientOrgUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
    ]
}

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

const response = await fetch('https://api2.rhombussystems.com/api/partner/getClientSummaries', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'partner-api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "clientOrgUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ]
  }),
});
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 = """
            {
              "clientOrgUuids": [
                "AAAAAAAAAAAAAAAAAAAAAA"
              ]
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/partner/getClientSummaries"))
            .header("x-auth-scheme", "partner-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

{
  "error": false,
  "errorCode": "<string>",
  "summaries": {
    "<key>": {
      "clientDeviceStatusMap": {
        "<key>": {
          "connectedCount": 45,
          "operationalCount": 42,
          "totalCount": 50
        }
      },
      "error": false,
      "licenseNextEndDate": "2026-01-01T00:00:00Z",
      "licenseTotalCount": 0,
      "licenseV2Enabled": true,
      "manuallySendLicenseExpirationEmailEnabled": true,
      "recentPolicyAlertCount": 0
    }
  }
}

Response

200 OK

application/json · object

Response object containing one summary for each requested client organization.

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

summariesobject | null

Map of client organization UUID to its summary. A client that could not be loaded, or that the caller may not see, has an entry with error set, so one client never fails the others.

Show child attributes

clientDeviceStatusMapobject | null

Map of device types to their connection counts

Show child attributes

connectedCountinteger<int32> | null

Number of connected devices

Example: 45

operationalCountinteger<int32> | null

Number of operational devices

Example: 42

totalCountinteger<int32> | null

Total number of devices

Example: 50

errorboolean | null

True when this client's summary could not be loaded or the caller may not see it

errorMsgstring | null

Why this client's summary is not available

licenseNextEndDatestring<date-time> | null

The closest future date on which licenses of the client expire. Null when there is none or when the caller may not see license statistics for this client.

licenseTotalCountinteger<int32> | null

Number of licenses of the client. Null when the caller may not see license statistics for this client.

licenseV2Enabledboolean | null

Whether license V2 is enabled for the client

manuallySendLicenseExpirationEmailEnabledboolean | null

Whether the partner sends license expiration emails manually for the client

recentPolicyAlertCountinteger<int32> | null

Number of policy alerts in the past 24 hours, counted up to 100

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, SELF_PROVISIONING_DISABLED, SKU_NOT_ALLOWED, QUANTITY_INVALID, AUTO_RENEW_REQUIRED, PROVISION_CAP_EXCEEDED, ACKNOWLEDGEMENT_REQUIRED, SIGNATURE_REQUIRED, APEX_VALIDATION, SKU_NOT_IN_PRICEBOOK.
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, NOT_VERIFIED_MSP, ORDER_NOT_YOURS.
429 Too Many Requests. errorCode is one of: RATE_LIMITED, QUOTE_RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE, SALESFORCE_UNAVAILABLE.