Skip to main content
POST
/
api
/
org
/
getClientOrg
Get client organization details
curl --request POST \
  --url https://api2.rhombussystems.com/api/org/getClientOrg \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'
{
  "featureFlags": {},
  "org": {
    "accountBillingContactEmail": "<string>",
    "accountOwnerEmail": "<string>",
    "accountTechnicalContactEmail": "<string>",
    "accountTechnicalContacts": [
      "<string>"
    ],
    "address1": "<string>",
    "address2": "<string>",
    "audioAnalysisEnabled": true,
    "audioRecordingEnabled": true,
    "bandwidthReportsDisabled": true,
    "companyLogoUrl": "<string>",
    "companyLogoUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "countryCode": "<string>",
    "createdAtMillis": 123,
    "criticalStatusEnabled": true,
    "defaultPlayerViewLiveType": "REALTIME",
    "deleted": true,
    "deletedAtMillis": 123,
    "developmentPartnerOrg": true,
    "firmwareUpdateSettings": {
      "intervalsV2": [
        {
          "minuteOfWeekStart": 123,
          "minuteOfWeekStop": 123
        }
      ],
      "mode": "MANUAL"
    },
    "firmwareUpdateSettingsOverrides": [
      {
        "deviceTypes": [
          "BLE_TRACKER"
        ],
        "firmwareUpdateSettings": {
          "intervalsV2": [
            {
              "minuteOfWeekStart": 123,
              "minuteOfWeekStop": 123
            }
          ],
          "mode": "MANUAL"
        }
      }
    ],
    "inactivityTimeout": 123,
    "itemizedInvoice": true,
    "keypadLogoUrl": "<string>",
    "keypadLogoUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "llmUsageEnabled": true,
    "maxAllowedSegmentMaxBytesMap": {},
    "mfaEnabled": true,
    "motionGridDisabled": true,
    "motionLightweightDisabled": true,
    "name": "<string>",
    "newCameraFramerateMap": {},
    "newCameraResolutionMap": {},
    "newCameraSegmentMaxBytesMap": {},
    "newCameraVideoTargetQualityMap": {},
    "newCameraZeroMotionVideoQualityMap": {},
    "notifyForHardwareFailureTickets": true,
    "partnerAccessAllowedUntil": 123,
    "postalCode": "<string>",
    "rhombusKeyLogoUrl": "<string>",
    "rhombusKeyLogoUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "salesforceAccountId": "<string>",
    "shareAiTrainingMediaWithRhombus": true,
    "subscriptionEndDate": 123,
    "subscriptionStatus": "TRIAL",
    "subscriptionType": "STARTER",
    "supportAccessAllowedUntil": 123,
    "tenantUrl": "<string>",
    "thumbstripDisabled": true,
    "type": "PARTNER",
    "uapSettings": {
      "enabled": true,
      "text": "<string>"
    },
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "v3AuthNumDaysSkip2FAForTrustedDevices": 123
  },
  "partnerOrgPermissionGroup": {
    "accessControlLocationAccessMap": {},
    "accessibleLocations": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "assignablePermissionGroups": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ],
    "defaultAccessControlPermissionForNewLocations": "READONLY",
    "defaultPermissionForNewLocations": "READONLY",
    "description": "<string>",
    "deviceAccessMap": {},
    "functionalityList": [
      "DEVICE_ADMINISTRATION"
    ],
    "inLine": true,
    "installer": true,
    "locationAccessMap": {},
    "locationGranularAccessMap": {},
    "mutable": true,
    "name": "<string>",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "storedInS3": true,
    "superAdmin": true,
    "userPermissionGroupAccessMap": {},
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

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 organization details.

orgUuid
string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object containing client organization details.

featureFlags
object

Map of feature flags for the client organization

org
object

List of Rhombus organizations the user has access to

partnerOrgPermissionGroup
object

Updated permission group configuration