Skip to content
Developers
Get API KeyGet API Key(opens in a new tab)

Org Integrations

Get organization integrations

Get details of all third-party integrations for organization

POST/api/integrations/org/getOrgIntegrations

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: 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 retrieving organization integrations.

Response

200 OK

application/json · object

Response object containing organization integrations configuration.

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
orgIntegrationsobject

Organization integrations configuration and settings

Show child attributes
amtSettingsobject
Show child attributes
alertUnauthorizedFacesboolean | null
createSeekPointsboolean | null
doorInfoMapobject | null
Show child attributes
assignedCameraListstring<RUUID>[] | null
clipDurationinteger<int32> | null
doorNamestring | null
leadingSecondsinteger<int32> | null
locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

remoteUnlockboolean | null
subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | null

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

emailstring | null
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

identifyFacesFromBadgeboolean | null
passwordstring | null
rhombusTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

saveClipsboolean | null
webhookIdinteger<int32> | null
webhookSignatureSecretstring | null
awsSettingsobject
Show child attributes
accessKeystring | null
bucketNamestring | null
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

secretKeystring | null
backblazeSettingsobject
Show child attributes
applicationKeystring | null
applicationKeyIdstring | null
bucketNamestring | null
enabledboolean | null
boxSettingsobject

Box file storage integration settings to update

Show child attributes
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

enterpriseIdstring | null
folderIdstring | null
brivoSettingsobject
Show child attributes
accessTokenstring | null
alertUnauthorizedFacesboolean | null
clientIdstring | null
clientSecretstring | null
createSeekPointsboolean | null
doorInfoMapobject | null
Show child attributes
assignedCameraListstring<RUUID>[] | null
clipDurationinteger<int32> | null
doorNamestring | null
leadingSecondsinteger<int32> | null
locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

remoteUnlockboolean | null
subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | null

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

doorToCameraMapobject | null
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

identifyFacesFromBadgeboolean | null
migratedboolean | null
passwordstring | null
refreshTokenstring | null
rhombusTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

saveClipsboolean | null
usernamestring | null
webhookIdinteger<int32> | null
butterflymxSettingsobject
Show child attributes
buildingWebhookIdMapobject | null

A HashMap of <ButterflyMx Building Id, Webhook Id>.

createSeekPointsboolean | null
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

indexFacesboolean | null
migratedboolean | null
panelInfoMapobject | null

A HashMap of <Panel Id, ButterflymxPanelInfoType>.

Show child attributes
assignedCameraListstring<RUUID>[] | null

The list of Rhombus Camera RUUIDs.

buildingIdinteger<int32> | null

The ButterflyMx Building Id.

locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

panelNamestring | null

The ButterflyMx Panel Name.

subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | null

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

refreshTokenstring | null
rhombusTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

saveClipsboolean | null
diceSettingsobject
Show child attributes
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

dropboxSettingsV2object

Dropbox integration settings to update

Show child attributes
accessTokenstring | null
accountEmailstring | null
accountNamestring | null
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

emailSettingsobject
Show child attributes
emailAddressesstring[] | null
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

envoySettingsobject

Envoy visitor management integration settings to update

Show child attributes
createSeekPointsboolean | null
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

envoyIntegrationInstalledboolean | null
indexFacesboolean | null
locationInfoMapobject | null
Show child attributes
assignedCameraListstring<RUUID>[] | null
locationNamestring | null
migratedboolean | null
refreshTokenstring | null
saveClipsboolean | null
geneaSettingsobject
Show child attributes
alertUnauthorizedFacesboolean | null
apiTokenstring | null
createSeekPointsboolean | null
doorInfoMapobject | null
Show child attributes
assignedCameraListstring<RUUID>[] | null
clipDurationinteger<int32> | null
doorNamestring | null
leadingSecondsinteger<int32> | null
locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

remoteUnlockboolean | null
subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | null

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

identifyFacesFromBadgeboolean | null
migratedboolean | null
rhombusTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

saveClipsboolean | null
webhookSignatureSecretstring | null
webhookUuidstring | null
googleSettingsobject

Google integration settings to update

Show child attributes
accountUserstring | null
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

folderIdstring | null
teamDriveIdstring | null
googleSettingsV2object
Show child attributes
defaultAlertFolderIdstring | null
defaultAlertFolderNamestring | null
defaultFolderIdstring | null
defaultFolderNamestring | null
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

refreshTokenstring | null
saveAllAlertsboolean | null
saveClipsboolean | null
haloSettingsobject
Show child attributes
alertAgressionboolean | null
alertCOboolean | null
alertCO2boolean | null
alertGunshotboolean | null
alertHelpboolean | null
alertMaskingboolean | null
alertTHCboolean | null
alertTamperboolean | null
alertTempboolean | null
alertVOCboolean | null
alertVapeboolean | null
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

saveClipsboolean | null
savedClipDurationMsinteger<int32> | null
sensorNamestring | null
sensorToCamerasMapobject | null
triggerNotificationboolean | null
urlstring | null
immixSettingsobject
Show child attributes
deviceListstring<RUUID>[] | null
enabledboolean | null
serverUrlstring | null
intuifaceSettingsobject
Show child attributes
deviceToTriggerMapobject | null
Show child attributes
apiKeystring | null
experienceIdsstring[] | null
experienceNamesstring[] | null
messagestring | null
parameter1string | null
parameter2string | null
parameter3string | null
playerDeviceNamesstring[] | null
playerIdsstring[] | null
playerTagsstring[] | null
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

kisiSettingsobject
Show child attributes
alertUnauthorizedFacesboolean | null
apiSecretKeystring | null
createSeekPointsboolean | null
defaultOptionsobject | null
Show child attributes
alertUnauthorizedFacesboolean | null
badgeAuthDisablesAlarmMonitoringboolean | null
createSeekPointsboolean | null
defaultOptionsEnabledboolean | null
identifyFacesFromBadgeboolean | null
saveClipsboolean | null
doorInfoMapobject | null
Show child attributes
assignedCameraListstring<RUUID>[] | null
clipDurationinteger<int32> | null
doorNamestring | null
leadingSecondsinteger<int32> | null
locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

remoteUnlockboolean | null
subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | null

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

doorToCameraMapobject | null
doorsValidatedboolean | null
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

identifyFacesFromBadgeboolean | null
migratedboolean | null
placeIdinteger<int32> | null
placeToSettingsMapobject | null
Show child attributes
alertUnauthorizedFacesboolean | null
badgeAuthDisablesAlarmMonitoringboolean | null
createSeekPointsboolean | null
doorInfoMapobject | null
Show child attributes
assignedCameraListstring<RUUID>[] | null
clipDurationinteger<int32> | null
doorNamestring | null
leadingSecondsinteger<int32> | null
locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

remoteUnlockboolean | null
subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | null

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

identifyFacesFromBadgeboolean | null
misconfiguredDoorsinteger<int32>[] | null
placeIdinteger<int32> | null
placeNamestring | null
rhombusTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

saveClipsboolean | null
webhookIdinteger<int32> | null
rhombusTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

saveClipsboolean | null
webhookIdinteger<int32> | null
lumeoSettingsobject
Show child attributes
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

mattermostSettingsobject
Show child attributes
channelstring | null
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

webhookUrlstring | null
microsoftTeamsSettingsobject
Show child attributes
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

webhookUrlstring | null
noonlightSettingsobject
Show child attributes
acceptedTermsOfServiceboolean | null
defaultContactsByLocationMapobject | null
Show child attributes
namestring | nullrequired

The name of the emergency contact.

phoneNumberstring | nullrequired

The phone number for this emergency contact.

defaultDelayByLocationsMapobject | null
defaultPromptByLocationsMapobject | null
emergencyContactsByLocationsMapobject | null
Show child attributes
emergencyContactListobject[] | null
Show child attributes
namestring | nullrequired

The name of the emergency contact.

phoneNumberstring | nullrequired

The phone number for this emergency contact.

minuteOfWeekStartinteger<int32> | null
minuteOfWeekStopinteger<int32> | null
enabledboolean | null
escalationSettingsByLocationsMapobject | null
Show child attributes
escalationDelayMinutesinteger<int32> | null
minuteOfWeekStartinteger<int32> | null
minuteOfWeekStopinteger<int32> | null
promptThemeenum<string>

Available options: THREAT, HUMAN

locationEntryInstructionsMapobject | null
pinsByLocationMapobject | null
Show child attributes
descriptionstring | null
namestring | null
pinstring | null
verificationPromptstring | null
office365Settingsobject

Office 365 integration settings to update

Show child attributes
driveIdstring | null
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

tenantIdstring | null
openpathSettingsobject
Show child attributes
alertUnauthorizedFacesboolean | null
createSeekPointsboolean | null
doorInfoMapobject | null
Show child attributes
assignedCameraListstring<RUUID>[] | null
clipDurationinteger<int32> | null
doorNamestring | null
leadingSecondsinteger<int32> | null
locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

remoteUnlockboolean | null
subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | null

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

doorToCameraMapobject | null
emailstring | null
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

eventToWebhookIdMapobject | null
eventToWebhookMapobject | null
Show child attributes
orgIdinteger<int32> | null
webhookIdinteger<int32> | null
identifyFacesFromBadgeboolean | null
migratedboolean | null
passwordstring | null
rhombusTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

saveClipsboolean | null
webhookIdinteger<int32> | null
opentechAllianceSettingsobject
Show child attributes
apiKeystring | null
apiSecretstring | null
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

facilityToSettingsMapobject | null
Show child attributes
alertUnauthorizedFacesboolean | null
createSeekPointsboolean | null
doorInfoMapobject | null
Show child attributes
actionGroupIdstring | null
assignedCameraListstring<RUUID>[] | null
clipDurationinteger<int32> | null
doorNamestring | null
leadingSecondsinteger<int32> | null
locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

remoteUnlockboolean | null
subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | null

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

identifyFacesFromBadgeboolean | null
saveClipsboolean | null
migratedboolean | null
orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

pagerDutySettingsobject
Show child attributes
allLocationIntegrationKeysstring[] | null
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

integrationKeystring | null
locationToIntegrationKeysMapobject | null
placeOsSettingsobject
Show child attributes
alertUnauthorizedFacesboolean | null
apiUrlstring | null
createSeekPointsboolean | null
doorInfoMapobject | null
Show child attributes
assignedCameraListstring<RUUID>[] | null
clipDurationinteger<int32> | null
doorNamestring | null
leadingSecondsinteger<int32> | null
locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

remoteUnlockboolean | null
subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | null

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

identifyFacesFromBadgeboolean | null
migratedboolean | null
rhombusTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

saveClipsboolean | null
webhookSignatureSecretstring | null
proDataKeySettingsobject
Show child attributes
alertUnauthorizedFacesboolean | null
badgeAuthDisablesAlarmMonitoringboolean | null
createSeekPointsboolean | null
doorInfoMapobject | null
Show child attributes
assignedCameraListstring<RUUID>[] | null
clipDurationinteger<int32> | null
doorNamestring | null
leadingSecondsinteger<int32> | null
locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

remoteUnlockboolean | null
subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | null

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

doorsValidatedboolean | null
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

identifyFacesFromBadgeboolean | null
misconfiguredDoorsstring[] | null
ouIdstring | null
rhombusTokenstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

saveClipsboolean | null
webhookIdstring | null
webhookSignatureSecretstring | null
saltoSettingsobject
Show child attributes
alertUnauthorizedFacesboolean | null
createSeekPointsboolean | null
enabledboolean | null
identifyFacesFromBadgeboolean | null
saveClipsboolean | null
tokenToCamerasMapobject | null
serviceNowSettingsobject
Show child attributes
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

instanceUrlstring | null
passwordstring | null
usernamestring | null
slackSettingsobject
Show child attributes
accessTokenstring | null
channelstring | null
enabledboolean | null
webhookUrlstring | null
slackSettingsV2object
Show child attributes
channelIdstring | null
channelNamestring | null
codestring | null
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

orgAccessTokenstring | null
sendChannelNotificationsboolean | null
sendUserNotificationsboolean | null
userMapobject | null

A HashMap of <RhombusOrgUser uuid : Slack user uuid, user access token>. This stores the information for each Slack user.

Show child attributes
userAccessTokenstring | null

Slack user access token

userIdstring | null

Slack user uuid

webhookUrlstring | null
squareSettingsobject
Show child attributes
enabledboolean | null
locationIdToDeviceUuidsMapobject | null
toastSettingsobject

Toast POS integration settings to update

Show child attributes
currentToastRestaurantGuidstring | null

The current restaurant guid you want to use

enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

migratedboolean | null
posInfoMapobject | null

A HashMap of <Service Area Guid, PosIntegrationInfoType>. This stores the Pos Information and assigned cameras.

Show child attributes
assignedCameraListstring<RUUID>[] | null

A list of camera guids from Rhombus that are assigned to the Pos device.

posNamestring | null

The name of the Pos device.

toastRestaurantInfoMapobject | null

A HashMap of <Restaurant Guid, ToastRestaurantInfo>. This stores the information for each restaurant.

Show child attributes
locationNamestring | null

The location name of the restaurant from Toast

restaurantNamestring | null

The name of the restaurant from Toast. e.g., COFFEE CAN

tpLinkSettingsobject
Show child attributes
cameraToSwitchMapobject | null
enabledboolean | null
passwordstring | null
targetStateinteger<int32> | null
urlstring | null
usernamestring | null
tritonSettingsobject
Show child attributes
alertAggressionboolean | null
alertCOboolean | null
alertCO2boolean | null
alertGunshotboolean | null
alertHelpboolean | null
alertMaskingboolean | null
alertTHCboolean | null
alertTamperboolean | null
alertVOCboolean | null
alertVapeboolean | null
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

saveClipsboolean | null
savedClipDurationMsinteger<int32> | null
sensorToCamerasMapobject | null
triggerNotificationboolean | null
urlstring | null
twilioSettingsobject
Show child attributes
enabledboolean | null
phoneNumbersstring[] | null
webhookSettingsobject

Webhook integration settings to update

Show child attributes
enabledboolean | null
enabledTimestampMsinteger<int64> | null
enablingUserstring | null
enablingUserUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

webhookSecretstring | null
webhookUrlstring | null
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.
  • 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.
  • 429 Too Many Requests. errorCode is one of: RATE_LIMITED.
  • 500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
  • 503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.