Get organization details V2

Get details about organization

POST /api/org/getOrgV2

Get organization details V2

cURL

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 '{}'

200

{
  "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,
    "deleted": true,
    "deletedAtMillis": 123,
    "developmentPartnerOrg": true,
    "firmwareUpdateSettings": {
      "intervalsV2": [
        {
          "minuteOfWeekStart": 123,
          "minuteOfWeekStop": 123
        }
      ]
    },
    "firmwareUpdateSettingsOverrides": [
      {
        "deviceTypes": [],
        "firmwareUpdateSettings": {
          "intervalsV2": [
            {
              "minuteOfWeekStart": 123,
              "minuteOfWeekStop": 123
            }
          ]
        }
      }
    ],
    "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,
    "supportAccessAllowedUntil": 123,
    "tenantUrl": "<string>",
    "thumbstripDisabled": true,
    "uapSettings": {
      "enabled": true,
      "text": "<string>"
    },
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "v3AuthNumDaysSkip2FAForTrustedDevices": 123
  },
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

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

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

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

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

Show child attributes

cameraConfigOptions · object

Map of hardware variations to available video configuration options

Show child attributes

error · boolean | null

errorMsg · string | null

featureFlags · object

Map of feature flags for the organization

Show child attributes

org · object

List of Rhombus organizations the user has access to

Show child attributes

warningMsg · string | null