Skip to main content
POST
/
api
/
partner
/
getClientSummaryInfo
Get client summary info
curl --request POST \
  --url https://api2.rhombussystems.com/api/partner/getClientSummaryInfo \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'
{
  "accountOwner": {
    "accessibleRhombusApps": [
      "PARTNER"
    ],
    "accountOwner": true,
    "bypassSaml": true,
    "changePasswordOnLogin": true,
    "createdAtMillis": 123,
    "deleted": true,
    "email": "<string>",
    "emailCaseSensitive": "<string>",
    "emailVerified": true,
    "firstName": "<string>",
    "lastName": "<string>",
    "mfaEnabled": true,
    "mfaTokenType": "EMAIL",
    "name": "<string>",
    "orgUserCustomizationFlags": {},
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "passwordSet": true,
    "rhombusUserUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "status": "JOINED",
    "updatedAtMillis": 123,
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  },
  "clientDeviceStatusMap": {},
  "error": true,
  "errorMsg": "<string>",
  "licenseV2Enabled": true,
  "locationCount": 3,
  "manuallySendLicenseExpirationEmailEnabled": false,
  "recentPolicyAlertCount": 5,
  "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 client summary information.

clientOrgUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object containing client summary information including account owner, device status, and settings.

accountOwner
object

List of users in the organization

clientDeviceStatusMap
object

Map of device types to their connection status counts

error
boolean | null
errorMsg
string | null
licenseV2Enabled
boolean | null

Whether license V2 is enabled for the client

Example:

true

locationCount
integer<int32> | null

Number of locations for the client

Example:

3

manuallySendLicenseExpirationEmailEnabled
boolean | null

Whether manual license expiration email sending is enabled

Example:

false

recentPolicyAlertCount
integer<int32> | null

Number of recent policy alerts

Example:

5

warningMsg
string | null