Skip to main content
POST
/
api
/
org
/
getOrgV2
Get organization details V2
curl --request POST \
  --url https://api2.rhombussystems.com/api/org/getOrgV2 \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '{}'
{
  "cameraConfigDefaults": {},
  "cameraConfigOptions": {},
  "error": true,
  "errorMsg": "<string>",
  "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
  },
  "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 organization details V2.

Response

200 - application/json

OK

Response object containing organization details V2 with camera configuration options.

cameraConfigDefaults
object

Map of hardware variations to default video configurations

cameraConfigOptions
object

Map of hardware variations to available video configuration options

error
boolean | null
errorMsg
string | null
featureFlags
object

Map of feature flags for the organization

org
object

List of Rhombus organizations the user has access to

warningMsg
string | null