Jump to Content
Get Started
Examples
API Documents
API Documents
Moon (Dark Mode)
Sun (Light Mode)
Get Started
Examples
API Documents
/api/help/feedback
JUMP TO
Rhombus API
Access Control Webservice
/api/accesscontrol/addUsersToAccessControlGroup
post
/api/accesscontrol/assignAccessControlCredential
post
/api/accesscontrol/createAccessControlCredentialByHexValueAndType
post
/api/accesscontrol/createAccessControlGroup
post
/api/accesscontrol/createAccessGrant
post
/api/accesscontrol/createAccessRevocation
post
/api/accesscontrol/createRhombusSecureCsnCredential
post
/api/accesscontrol/createStandardCsnCredential
post
/api/accesscontrol/createWiegand64BitRawCredential
post
/api/accesscontrol/createWiegandCredential
post
/api/accesscontrol/createWiegandD10202Credential
post
/api/accesscontrol/createWiegandH10301Credential
post
/api/accesscontrol/createWiegandH10304Credential
post
/api/accesscontrol/deleteAccessControlCredential
post
/api/accesscontrol/deleteAccessControlGroup
post
/api/accesscontrol/deleteLocationAccessGrant
post
/api/accesscontrol/deleteLocationAccessRevocation
post
/api/accesscontrol/deleteUnassignedAccessControlCredential
post
/api/accesscontrol/findAccessControlCredentialByOrg
post
/api/accesscontrol/findAccessControlCredentialByUser
post
/api/accesscontrol/findAccessControlCredentialByUsers
post
/api/accesscontrol/findAccessControlGroupByExactName
post
/api/accesscontrol/findAccessControlGroupMembershipsByUser
post
/api/accesscontrol/findAccessControlGroupsByNamePrefix
post
/api/accesscontrol/findAccessControlGroupsByOrg
post
/api/accesscontrol/findAccessControlGroupsByUserMembership
post
/api/accesscontrol/findAllUsersForAccessControlGroup
post
/api/accesscontrol/findCredentialHistoryByCredentialHexValue
post
/api/accesscontrol/findCredentialHistoryByCredentialValue
post
/api/accesscontrol/findCredentialHistoryByUser
post
/api/accesscontrol/findLocationAccessGrantsByAccessControlledDoor
post
/api/accesscontrol/findLocationAccessGrantsByDoorLabel
post
/api/accesscontrol/findLocationAccessGrantsByGroup
post
/api/accesscontrol/findLocationAccessGrantsByLocation
post
/api/accesscontrol/findLocationAccessGrantsByLocationAndUser
post
/api/accesscontrol/findLocationAccessGrantsByOrg
post
/api/accesscontrol/findLocationAccessGrantsByUser
post
/api/accesscontrol/findLocationAccessRevocationsByAccessControlledDoor
post
/api/accesscontrol/findLocationAccessRevocationsByDoorLabel
post
/api/accesscontrol/findLocationAccessRevocationsByGroup
post
/api/accesscontrol/findLocationAccessRevocationsByOrg
post
/api/accesscontrol/findLocationAccessRevocationsByUser
post
/api/accesscontrol/getLocationAccessGrant
post
/api/accesscontrol/getLocationAccessRevocation
post
/api/accesscontrol/getRhombusSecureCsnCredentialDetails
post
/api/accesscontrol/getStandardCsnCredentialDetails
post
/api/accesscontrol/removeUsersFromAccessControlGroup
post
/api/accesscontrol/revokeAccessControlCredential
post
/api/accesscontrol/suspendAccessControlCredential
post
/api/accesscontrol/unlockAccessControlledDoor
post
/api/accesscontrol/unsuspendAccessControlCredential
post
/api/accesscontrol/updateAccessControlGroup
post
/api/accesscontrol/updateAccessGrant
post
/api/accesscontrol/updateAccessRevocation
post
/api/accesscontrol/updateRhombusSecureCsnCredential
post
/api/accesscontrol/updateRhombusSecureMobileCredential
post
/api/accesscontrol/updateStandardCsnCredential
post
Lockdown Plan Webservice
/api/accesscontrol/lockdownPlan/activateLockdownForLocation
post
/api/accesscontrol/lockdownPlan/createLocationLockdownPlan
post
/api/accesscontrol/lockdownPlan/createLockdownRuleForLocation
post
/api/accesscontrol/lockdownPlan/deactivateLockdownForLocation
post
/api/accesscontrol/lockdownPlan/deleteLocationLockdownState
post
/api/accesscontrol/lockdownPlan/deleteLockdownPlan
post
/api/accesscontrol/lockdownPlan/deleteLockdownRuleForLocation
post
/api/accesscontrol/lockdownPlan/disableLockdownTestModeForLocation
post
/api/accesscontrol/lockdownPlan/enableLockdownTestModeForLocation
post
/api/accesscontrol/lockdownPlan/findLocationLockdownEvents
post
/api/accesscontrol/lockdownPlan/findLocationLockdownStates
post
/api/accesscontrol/lockdownPlan/findLockdownPlans
post
/api/accesscontrol/lockdownPlan/findLockdownPlansByLocation
post
/api/accesscontrol/lockdownPlan/getLockdownPlan
post
/api/accesscontrol/lockdownPlan/getLockdownRulesForLocation
post
/api/accesscontrol/lockdownPlan/getOrCreateLocationLockdownState
post
/api/accesscontrol/lockdownPlan/updateLocationLockdownPlan
post
Alert Monitoring Webservice
/api/alertmonitoring/cancelThreatCase
post
/api/alertmonitoring/createCustomPinForLocation
post
/api/alertmonitoring/createPinForLocation
post
/api/alertmonitoring/deletePinForLocation
post
/api/alertmonitoring/dismissThreatCase
post
/api/alertmonitoring/escalateThreatCaseToAlarm
post
AudioGateway Webservice
/api/audiogateway/delete
post
/api/audiogateway/getAudioSeekpoints
post
/api/audiogateway/getConfig
post
/api/audiogateway/getFullAudioGatewayState
post
/api/audiogateway/getMediaUris
post
/api/audiogateway/getMinimalAudioGatewayStateList
post
/api/audiogateway/getPresenceWindows
post
/api/audiogateway/getUptimeWindows
post
/api/audiogateway/updateConfig
post
/api/audiogateway/updateDetails
post
Badge Reader Webservice
/api/badgereader/delete
post
/api/badgereader/reboot
post
BLE Webservice
/api/ble/getBaseStations
post
Button Webservice
/api/button/createRuleForButton
post
/api/button/deleteRuleForButton
post
/api/button/getButtonPressEventsForSensor
post
/api/button/getButtonRulesForOrg
post
/api/button/getMinimalButtonStateList
post
/api/button/getRulesForButton
post
/api/button/updateConfig
post
/api/button/updateDetails
post
Camera Webservice
/api/camera/calibrateFloorplanProjection
post
/api/camera/createCustomFootageSeekpoints
post
/api/camera/createFootageBoundingBoxes
post
/api/camera/createProtectedSharedLiveVideoStream
post
/api/camera/createProtectedSharedVideoWall
post
/api/camera/createRawHttpStream
post
/api/camera/createSharedLiveVideoStream
post
/api/camera/createSharedVideoWall
post
/api/camera/createVideoWall
post
/api/camera/delete
post
/api/camera/deleteCustomFootageSeekpoints
post
/api/camera/deleteRawHttpStream
post
/api/camera/deleteSharedLiveVideoStream
post
/api/camera/deleteSharedVideoWall
post
/api/camera/deleteVideoWall
post
/api/camera/erase
post
/api/camera/findAllRawHttpStreams
post
/api/camera/findAllSharedLiveVideoStreams
post
/api/camera/findSharedLiveVideoStreams
post
/api/camera/findSharedVideoWalls
post
/api/camera/generateBatchRegistrationInfo
post
/api/camera/generateWifiChangeAuthorizationToken
post
/api/camera/getBatchRegistrationUsage
post
/api/camera/getCameraAIThresholds
post
/api/camera/getCloudArchivedMediaInfo
post
/api/camera/getCloudArchivingConfig
post
/api/camera/getConfig
post
/api/camera/getCurrentState
post
/api/camera/getCustomFootageSeekpointsV2
post
/api/camera/getDetails
post
/api/camera/getFootageBoundingBoxes
post
/api/camera/getFootageBoundingBoxesForMultiple
post
/api/camera/getFootageSeekpointsForMultiple
post
/api/camera/getFootageSeekpointsV2
post
/api/camera/getFullCameraState
post
/api/camera/getMediaUris
post
/api/camera/getMinimalCameraLocationMap
post
/api/camera/getMinimalCameraStateList
post
/api/camera/getMinimalList
post
/api/camera/getOfflineLanStreamingInfo
post
/api/camera/getPresenceWindows
post
/api/camera/getRawHttpStreams
post
/api/camera/getStorageRecoveryFile
post
/api/camera/getUptimeWindows
post
/api/camera/getVideoWalls
post
/api/camera/reboot
post
/api/camera/updateCameraAIThresholds
post
/api/camera/updateCameraLineCrossingThresholds
post
/api/camera/updateConfig
post
/api/camera/updateDetails
post
/api/camera/updateDetailsBulkV2
post
/api/camera/updateDetailsV2
post
/api/camera/updateFirmware
post
/api/camera/updateVideoWalls
post
/api/camera/updateWifi
post
Climate Webservice
/api/climate/deleteEnvironmentalGateway
post
/api/climate/getClimateEventsForSensor
post
/api/climate/getClimatePresenceWindows
post
/api/climate/getConfig
post
/api/climate/getEnvironmentalGatewayShadows
post
/api/climate/getEventsForEnvironmentalGateway
post
/api/climate/getMinimalClimateStateList
post
/api/climate/getMinimalEnvironmentalGatewayStates
post
/api/climate/getMinimalStateEventsForEnvironmentalGateway
post
/api/climate/reboot
post
/api/climate/updateDetails
post
/api/climate/updateEnvironmentalGatewayDetails
post
Component Webservice
/api/component/addAccessControlledDoorLabel
post
/api/component/createAccessControlledDoor
post
/api/component/createIntegratedDoorPositionIndicator
post
/api/component/createIntegratedDoorRelay
post
/api/component/createIntegratedGenericButton
post
/api/component/createIntegratedGenericInput
post
/api/component/createIntegratedGenericRelay
post
/api/component/createIntegratedRequestToExit
post
/api/component/createOsdpDoorReader
post
/api/component/createRhombusOsdpDoorReader
post
/api/component/createWiegandReader
post
/api/component/deleteAccessControlledDoor
post
/api/component/deleteComponent
post
/api/component/deleteComponentsByOwnerDevice
post
/api/component/findAccessControlledDoorShadows
post
/api/component/findAccessControlledDoorShadowsByLocation
post
/api/component/findAccessControlledDoors
post
/api/component/findAccessControlledDoorsByLocation
post
/api/component/findAccessControlledDoorsByOwnerDevice
post
/api/component/findAllComponentShadows
post
/api/component/findComponentEventsByAccessControlledDoor
post
/api/component/findComponentEventsByApiToken
post
/api/component/findComponentEventsByComponent
post
/api/component/findComponentEventsByCorrelation
post
/api/component/findComponentEventsByCredentialHexValue
post
/api/component/findComponentEventsByCredentialUuid
post
/api/component/findComponentEventsByCredentialValue
post
/api/component/findComponentEventsByLocation
post
/api/component/findComponentEventsByOwnerDevice
post
/api/component/findComponentEventsBySupportAuthority
post
/api/component/findComponentEventsByUser
post
/api/component/findComponentEventsForVideoIntercom
post
/api/component/findComponentSeekPointsByAccessControlledDoor
post
/api/component/findComponentSeekPointsByAccessControlledDoors
post
/api/component/findComponentSeekPointsByComponent
post
/api/component/findComponentSeekPointsByLocation
post
/api/component/findComponentSeekPointsByOwnerDevice
post
/api/component/findComponentSeekPointsByUser
post
/api/component/findComponentShadowsByOwnerDevice
post
/api/component/findComponentsByOwnerDevice
post
/api/component/findMinimalStateAccessControlledDoors
post
/api/component/findMinimalStateAccessControlledDoorsByLocation
post
/api/component/getAccessControlledDoorLabelsForOrg
post
/api/component/getOrCreateDevicePhysicalPortConfig
post
/api/component/removeAccessControlledDoorLabel
post
/api/component/updateAccessControlledDoor
post
/api/component/updateIntegratedDoorPositionIndicator
post
/api/component/updateIntegratedDoorRelay
post
/api/component/updateIntegratedGenericButton
post
/api/component/updateIntegratedGenericInput
post
/api/component/updateIntegratedGenericRelay
post
/api/component/updateIntegratedGenericRelaySteadyState
post
/api/component/updateIntegratedGenericRelayTransientState
post
/api/component/updateIntegratedRequestToExit
post
/api/component/updateOsdpDoorReader
post
/api/component/updateRhombusOsdpDoorReader
post
/api/component/updateWiegandDoorReader
post
Customer Webservice
/api/customer/deleteAllNotificationSnoozeSettings
post
/api/customer/deleteNotificationSnoozeSettingForComponentComposite
post
/api/customer/deleteNotificationSnoozeSettingForDevice
post
/api/customer/deleteNotificationSnoozeSettingForLocation
post
/api/customer/getUserSnoozedNotificationSettings
post
Device Config Webservice
/api/deviceconfig/getFacetedConfig
post
/api/deviceconfig/updateFacetedConfig
post
Door Webservice
/api/door/getDoorEventsForSensor
post
/api/door/getDoorPresenceWindows
post
/api/door/getMinimalDoorStateList
post
/api/door/updateDetails
post
Doorbell Camera Webservice
/api/doorbellcamera/calibrateFloorplanProjection
post
/api/doorbellcamera/createRuleForDoorbellCamera
post
/api/doorbellcamera/createSharedLiveVideoStream
post
/api/doorbellcamera/delete
post
/api/doorbellcamera/deleteRuleForDoorbellCamera
post
/api/doorbellcamera/findComponentEventsForDoorbellCamera
post
/api/doorbellcamera/findComponentSeekPointsForDoorbellCamera
post
/api/doorbellcamera/findSharedLiveVideoStreams
post
/api/doorbellcamera/getDoorbellCameraRulesForOrg
post
/api/doorbellcamera/getRulesForDoorbellCamera
post
Door Controller Webservice
/api/doorcontroller/registerDiscoveredRhombusReader
post
/api/doorcontroller/updateDetails
post
Event Webservice
/api/event/createSharedClipGroupV3
post
/api/event/deleteAlertMonitoringThreatCase
post
/api/event/deleteAlertMonitoringThreatCaseByStatus
post
/api/event/deleteSavedClip
post
/api/event/deleteSharedClipGroupV2
post
/api/event/dismissAllPolicyAlertsForDevice
post
/api/event/dismissAllPolicyAlertsV2
post
/api/event/dismissPolicyAlertV2
post
/api/event/dismissPolicyAlertsV2
post
/api/event/getAlertMonitoringThreatCase
post
/api/event/getAlertMonitoringThreatCases
post
/api/event/getClipWithProgress
post
/api/event/getClipsWithProgress
post
/api/event/getExpiringClipsForOrg
post
/api/event/getMotionGrid
post
/api/event/getMotionHeatMap
post
/api/event/getPolicyAlert
post
/api/event/getPolicyAlertCount
post
/api/event/getPolicyAlertDetails
post
/api/event/getPolicyAlertGroupsForDevice
post
/api/event/getPolicyAlertGroupsForLocation
post
/api/event/getPolicyAlertGroupsV2
post
/api/event/getPolicyAlertV2
post
/api/event/getPolicyAlerts
post
/api/event/getPolicyAlertsV2
post
/api/event/getSavedClipCount
post
/api/event/getSavedClipDetails
post
/api/event/getSavedClips
post
/api/event/getSavedClipsByExternalTransactionId
post
/api/event/getSavedClipsV2
post
/api/event/getSharedClipGroupDetails
post
/api/event/getSharedClipGroupsV2
post
/api/event/getSplicedClipsInProgress
post
/api/event/getUnhealthyDeviceAlerts
post
/api/event/muteNotificationsForDevice
post
/api/event/reportBadPolicyAlert
post
/api/event/savePolicyAlertV2
post
/api/event/searchMotionGrid
post
/api/event/searchMotionGridWithActivities
post
/api/event/unSavePolicyAlertV2
post
/api/event/updateSavedClip
post
/api/event/updateSharedClipGroupV2
post
Event Search Webservice
/api/eventSearch/getCameraOrDoorbellCameraSeekpoints
post
/api/eventSearch/getEventSeekpoints
post
Export Webservice
/api/export/audit
post
/api/export/climateEvents
post
/api/export/countReports
post
/api/export/diagnostic
post
/api/export/doorEvents
post
/api/export/environmentalGatewayEvents
post
/api/export/inventory
post
/api/export/motionEvents
post
/api/export/peopleCountEvents
post
/api/export/peopleEvents
post
/api/export/proximityEvents
post
/api/export/proximityLocomotionEvents
post
/api/export/uptime
post
/api/export/users
post
/api/export/vehicleEvents
post
/api/export/vehicleEventsV2
post
Feature Webservice
/api/feature/getDeviceEventTypes
post
/api/feature/getDeviceFeatures
post
/api/feature/getDeviceFeaturesList
post
/api/feature/getFeatureCompatabilityMatrix
post
/api/feature/updateDeviceFeatures
post
Help Webservice
/api/help/feedback
post
/api/help/openTickets
post
/api/help/openTicketsV2
post
/api/help/rma
post
/api/help/ticket
post
/api/help/ticketWithFile
post
/api/help/triageDevice
post
Access Control Integrations Webservice
/api/integrations/accessControl/deleteInnerRangeIntegration
post
/api/integrations/accessControl/getInnerRangeConsoles
post
/api/integrations/accessControl/getInnerRangeDoors
post
/api/integrations/accessControl/getInnerRangeIntegration
post
/api/integrations/accessControl/unlockInnerRangeDoor
post
/api/integrations/accessControl/updateInnerRangeIntegration
post
Incident Management Integrations Webservice
Integrations Webservice
/api/integrations/serviceManagement/createEnvoyInvite
post
/api/integrations/deleteAmtIntegration
post
/api/integrations/webhooks/deleteWebhookIntegrationV2
post
/api/integrations/accessControl/deleteAvigilonAltaIntegrationV2
post
/api/integrations/deleteDeviceIntegration
post
/api/integrations/serviceManagement/deleteEnvoyIntegrationV2
post
/api/integrations/IoT/deleteOmnialertIntegration
post
/api/integrations/incidentManagement/deleteInformacastIntegration
post
/api/integrations/webhooks/getWebhookIntegration
post
/api/integrations/org/getOrgIntegrationsV2
post
/api/integrations/deleteMattermostIntegration
post
/api/integrations/webhooks/subscribeZapierWebhook
post
/api/integrations/accessControl/deleteBrivoIntegrationV2
post
/api/integrations/IoT/deleteShellyIntegration
post
/api/integrations/deleteOpenAIIntegration
post
/api/integrations/IoT/getOmnialertIntegration
post
/api/integrations/webhooks/unsubscribeZapierWebhook
post
/api/integrations/serviceManagement/deleteToastIntegrationV2
post
/api/integrations/deleteWebhookIntegration
post
/api/integrations/incidentManagement/deleteMicrosoftTeamsIntegrationV2
post
/api/integrations/serviceManagement/getCalendlyEventDetails
post
/api/integrations/accessControl/deleteButterflymxIntegrationV2
post
/api/integrations/IoT/getShellyIntegration
post
/api/integrations/deleteWebhookIntegrationV2
post
/api/integrations/serviceManagement/getEnvoyIntegration
post
/api/integrations/incidentManagement/deleteMicrosoftTeamsUser
post
/api/integrations/webhooks/updateWebhookIntegrationV2
post
/api/integrations/storage/getGoogleIntegration
post
/api/integrations/getAmtReaders
post
/api/integrations/incidentManagement/deleteOpenAIIntegration
post
/api/integrations/accessControl/deleteGeneaIntegrationV2
post
/api/integrations/serviceManagement/getToastIntegration
post
/api/integrations/getApiTokenApplications
post
/api/integrations/IoT/updateOmnialertIntegration
post
/api/integrations/getApiTokens
post
/api/integrations/IoT/updateShellyIntegration
post
/api/integrations/getCalendlyEventDetails
post
/api/integrations/accessControl/deleteKisiIntegrationV2
post
/api/integrations/getDeviceIntegration
post
/api/integrations/serviceManagement/updateEnvoyIntegrationV2
post
/api/integrations/incidentManagement/getDiceIntegration
post
/api/integrations/storage/revokeGoogleDriveAccess
post
/api/integrations/getOpenAIIntegration
post
/api/integrations/incidentManagement/getInformacastIntegration
post
/api/integrations/getOpenAIModels
post
/api/integrations/incidentManagement/getInformacastScenarios
post
/api/integrations/accessControl/deleteOpentechAllianceIntegrationV2
post
/api/integrations/serviceManagement/updateToastIntegrationV2
post
/api/integrations/getOrgIntegrations
post
/api/integrations/getOrgIntegrationsV2
post
/api/integrations/incidentManagement/getMicrosoftTeamsIntegration
post
/api/integrations/accessControl/deletePdkIntegrationV2
post
/api/integrations/getWebhookIntegration
post
/api/integrations/incidentManagement/getMicrosoftUsersJoinedTeams
post
/api/integrations/revokeApiToken
post
/api/integrations/incidentManagement/getOpenAIIntegration
post
/api/integrations/accessControl/deletePlaceOsIntegrationV2
post
/api/integrations/submitApiTokenApplication
post
/api/integrations/incidentManagement/getOpenAIModels
post
/api/integrations/subscribeZapierWebhook
post
/api/integrations/incidentManagement/installMicrosoftTeamsBotForTeam
post
/api/integrations/accessControl/getAvigilonAltaIntegration
post
/api/integrations/unsubscribeZapierWebhook
post
/api/integrations/incidentManagement/installMicrosoftTeamsBotForUser
post
/api/integrations/updateAmtIntegration
post
/api/integrations/incidentManagement/uninstallMicrosoftTeamsBotForTeam
post
/api/integrations/accessControl/getBrivoDoorsV2
post
/api/integrations/updateDeviceIntegration
post
/api/integrations/incidentManagement/uninstallMicrosoftTeamsBotForUser
post
/api/integrations/accessControl/getBrivoIntegrationV2
post
/api/integrations/updateMattermostIntegration
post
/api/integrations/accessControl/getButterflymxIntegrationV2
post
/api/integrations/updateOpenAIIntegration
post
/api/integrations/incidentManagement/updateInformacastIntegration
post
/api/integrations/accessControl/getButterflymxPanelsV2
post
/api/integrations/updateWebhookIntegration
post
/api/integrations/updateWebhookIntegrationV2
post
/api/report/getEnvoyDeliveries
post
/api/integrations/accessControl/getGeneaIntegration
post
/api/report/getEnvoyEmployees
post
/api/integrations/incidentManagement/updateMicrosoftTeamsIntegrationV2
post
/api/integrations/incidentManagement/updateOpenAIIntegration
post
/api/report/getEnvoyVisitors
post
/api/integrations/accessControl/getKisiIntegration
post
/api/integrations/accessControl/getKisiIntegrationV2
post
/api/integrations/accessControl/getOpenpathLockdownPlans
post
/api/integrations/accessControl/getOpentechAllianceFacilitiesV2
post
/api/integrations/accessControl/getOpentechAllianceIntegrationV2
post
/api/integrations/accessControl/getPdkIntegration
post
/api/integrations/accessControl/getPlaceOsIntegrationV2
post
/api/integrations/accessControl/revertOpenpathLockdown
post
/api/integrations/accessControl/triggerOpenpathLockdown
post
/api/integrations/accessControl/unlockBrivoDoorV2
post
/api/integrations/accessControl/unlockOpentechAllianceDoorV2
post
/api/integrations/accessControl/updateAvigilonAltaIntegrationV2
post
/api/integrations/accessControl/updateBrivoIntegrationV2
post
/api/integrations/accessControl/updateButterflymxIntegrationV2
post
/api/integrations/accessControl/updateGeneaIntegrationV2
post
/api/integrations/accessControl/updateKisiIntegrationV2
post
/api/integrations/accessControl/updateOpentechAllianceIntegrationV2
post
/api/integrations/accessControl/updatePdkIntegrationV2
post
/api/integrations/accessControl/updatePlaceOsSettingsV2
post
IoT Integrations Webservice
Org Integrations Webservice
Service Management Integrations Webservice
Storage Integrations Webservice
Webhook Integrations Webservice
Alarm Monitoring Keypad Webservice
/api/keypad/claimKeypadActivationToken
post
/api/keypad/getKeypadsForLocation
post
/api/keypad/getKeypadsForOrg
post
/api/keypad/unregisterKeypad
post
/api/keypad/updateKeypad
post
Guest Management Kiosk Webservice
/api/kiosk/updateKiosk
post
License Webservice
/api/license/assignACUDoorLicense
post
/api/license/assignAlertMonitoringLicense
post
/api/license/assignDeviceLicense
post
/api/license/assignLicense
post
/api/license/getACUDoorLicenses
post
/api/license/getACUDoorLicensesForClientOrg
post
/api/license/getAlertMonitoringLicenses
post
/api/license/getAlertMonitoringLicensesForClientOrg
post
/api/license/getDeviceLicenses
post
/api/license/getDeviceLicensesForClientOrg
post
/api/license/getLicenses
post
/api/license/getLicensesForClientOrg
post
Location Webservice
/api/location/addLocationLabel
post
/api/location/createLocation
post
/api/location/deleteLocation
post
/api/location/geoCode
post
/api/location/getLocation
post
/api/location/getLocationLabelsForOrg
post
/api/location/getLocations
post
/api/location/getLocationsAssociatedToLocationLabelsByOrg
post
/api/location/getLocationsByGeo
post
/api/location/getLocationsBySubLocationsHierarchyKey
post
/api/location/removeLocationLabel
post
/api/location/selectiveUpdateLocation
post
/api/location/updateLocation
post
Logistics Webservice
/api/logistics/getRMAs
post
/api/logistics/getShipments
post
/api/logistics/getWarrantyApprovedRMAs
post
OAuth Webservice
/api/oauth/authorize
get
/api/oauth/deleteApplication
post
/api/oauth/getAllApplicationsForOrg
post
/api/oauth/getApplicationByClientId
post
/api/oauth/submitApplication
post
/api/oauth/updateApplication
post
Occupancy Webservice
/api/occupancy/getMinimalOccupancySensorStateList
post
/api/occupancy/getOccupancyEventsForSensor
post
/api/occupancy/getOccupancyPresenceWindows
post
/api/occupancy/updateDetails
post
Org Webservice
/api/org/claimActivationToken
post
/api/org/claimShipmentRegistrationToken
post
/api/org/createPendingRegistration
post
/api/org/deleteCloudArchivingConfig
post
/api/org/deleteKeypadLogo
post
/api/org/deleteRhombusKeyLogo
post
/api/org/findAllHardwareWithPendingRegistration
post
/api/org/findHardwareAvailableForPendingRegistration
post
/api/org/findIfTeamNameAvailable
post
/api/org/findSCIMSettingsForOrg
post
/api/org/generateFederatedSessionToken
post
/api/org/getClientOrg
post
/api/org/getCloudArchivingConfigs
post
/api/org/getFeatures
post
/api/org/getOrg
post
/api/org/getOrgIntegrations
post
/api/org/getOrgNotificationTemplate
post
/api/org/getOrgNotificationTemplateV2
post
/api/org/getOrgV2
post
/api/org/getSAMLSettings
post
/api/org/getSAMLSettingsV2
post
/api/org/getScimDisplayInfo
post
/api/org/getTemporaryOrgToken
post
/api/org/peekShipmentRegistrationToken
post
/api/org/removePendingRegistration
post
/api/org/revokeSCIMAccessForOrg
post
/api/org/setupSCIMAccessForOrg
post
/api/org/updateAiTrainingSettings
post
/api/org/updateCloudArchivingConfig
post
/api/org/updateFirmwareSettings
post
/api/org/updateGeneralSettings
post
/api/org/updateMFASettings
post
/api/org/updateOrg
post
/api/org/updateOrgAudioAnalysisPolicy
post
/api/org/updateOrgAudioRecordingPolicy
post
/api/org/updateOrgNotificationTemplate
post
/api/org/updateOrgNotificationTemplateV2
post
/api/org/updatePendingRegistration
post
/api/org/updateSAMLSettings
post
/api/org/updateSAMLSettingsV2
post
/api/org/updateSCIMSettingsForOrg
post
Partner Webservice
/api/partner/createPartnerClient
post
/api/partner/customizeClient
post
/api/partner/customizeClientDevice
post
/api/partner/deleteClient
post
/api/partner/getApiTokenApplications
post
/api/partner/getApiTokens
post
/api/partner/getClientDevices
post
/api/partner/getClientStatusMap
post
/api/partner/getClientSummaryInfo
post
/api/partner/getClients
post
/api/partner/getClientsV2
post
/api/partner/getDeviceLicensesForOrg
post
/api/partner/getLicensesForOrg
post
/api/partner/getListOfAllClientDevices
post
/api/partner/getListOfAvailableHardware
post
/api/partner/getShipments
post
/api/partner/reassignDeviceOrg
post
/api/partner/registerCameraToClient
post
/api/partner/registerDeal
post
/api/partner/revokeApiToken
post
/api/user/updatePartnerUser
post
Permission Webservice
/api/permission/createPartnerPermissionGroup
post
/api/permission/createPermissionGroup
post
/api/permission/deletePartnerPermissionGroup
post
/api/permission/deletePermissionGroup
post
/api/permission/getPartnerPermissionGroups
post
/api/permission/getPermissionGroups
post
/api/permission/getPermissionsForCurrentPartner
post
/api/permission/getPermissionsForCurrentUser
post
/api/permission/updatePartnerPermissionGroup
post
/api/permission/updatePermissionGroup
post
Policy Webservice
/api/policy/createAccessControlledDoorPolicy
post
/api/policy/createAudioPolicy
post
/api/policy/createCameraPolicy
post
/api/policy/createClimatePolicy
post
/api/policy/createDoorPolicy
post
/api/policy/createOccupancyPolicy
post
/api/policy/createPolicyAddendumForLocation
post
/api/policy/createPolicyAddendumsForDevices
post
/api/policy/createProximityPolicy
post
/api/policy/createSchedule
post
/api/policy/createVideoIntercomPolicy
post
/api/policy/deleteAccessControlledDoorPolicy
post
/api/policy/deleteAudioPolicy
post
/api/policy/deleteCameraPolicy
post
/api/policy/deleteClimatePolicy
post
/api/policy/deleteDevicePolicyAddendums
post
/api/policy/deleteDoorPolicy
post
/api/policy/deleteLocationPolicyAddendum
post
/api/policy/deleteOccupancyPolicy
post
/api/policy/deletePolicyPauseSettingForComponentComposite
post
/api/policy/deletePolicyPauseSettingForDevice
post
/api/policy/deletePolicyPauseSettingForLocation
post
/api/policy/deleteProximityPolicy
post
/api/policy/deleteSchedule
post
/api/policy/deleteVideoIntercomPolicy
post
/api/policy/findSchedules
post
/api/policy/getAccessControlledDoorPolicies
post
/api/policy/getAudioPolicies
post
/api/policy/getCameraPolicies
post
/api/policy/getClimatePolicies
post
/api/policy/getDoorPolicies
post
/api/policy/getOccupancyPolicies
post
/api/policy/getPoliciesUsingSchedule
post
/api/policy/getPolicyAddendums
post
/api/policy/getPolicyPauseSettings
post
/api/policy/getProximityPolicies
post
/api/policy/getVideoIntercomPolicies
post
/api/policy/pauseAlertPolicyForComponentComposite
post
/api/policy/pauseAlertPolicyForDevice
post
/api/policy/pauseAlertPolicyForLocation
post
/api/policy/updateAccessControlledDoorPolicy
post
/api/policy/updateAudioPolicy
post
/api/policy/updateCameraPolicy
post
/api/policy/updateClimatePolicy
post
/api/policy/updateDoorPolicy
post
/api/policy/updateOccupancyPolicy
post
/api/policy/updateProximityPolicy
post
/api/policy/updateSchedule
post
/api/policy/updateVideoIntercomPolicy
post
Proximity Webservice
/api/proximity/getLocomotionEventsForTag
post
/api/proximity/getMinimalProximityStateList
post
/api/proximity/getProximityEventsForTag
post
/api/proximity/updateDetails
post
RapidSOS Webservice
/api/rapidsos/getNearbyFeeds
post
Relay Webservice
/api/relay/assignThirdPartyCameraToNVR
post
/api/relay/assignThirdPartyCameraToRelayCamera
post
/api/relay/authenticateThirdPartyCamera
post
/api/relay/createThirdPartyCameraPassword
post
/api/relay/deleteThirdPartyCameraPassword
post
/api/relay/getAssignedThirdPartyCameras
post
/api/relay/getThirdPartyCameraPasswords
post
/api/relay/ptzMove
post
/api/relay/ptzStatus
post
/api/relay/reboot
post
/api/relay/register
post
/api/relay/unassignThirdPartyCamera
post
Report Webservice
/api/report/getAuditFeed
post
/api/report/getCountReport
post
/api/report/getCountReportV2
post
/api/report/getCountReports
post
/api/report/getCountReportsForDevicesAtLocation
post
/api/report/getDiagnosticFeed
post
/api/report/getIntegrationDiagnosticEvents
post
/api/report/getLicensePlatesByDevice
post
/api/report/getMostRecentPeopleCountEvents
post
/api/report/getProximityTagLocationsByDate
post
/api/report/getRunningAverage
post
/api/report/getSummaryCountReport
post
/api/report/getThresholdCrossingCounts
post
/api/report/getThresholdCrossingEvents
post
/api/report/getThresholdCrossingEventsForDevice
post
/api/report/getToastEventsTableAllLocations
post
/api/report/resetRunningAverage
post
Rules Webservice
/api/rules/createRule
post
/api/rulesRecords/deleteRulesEventRecord
post
/api/rules/deleteRule
post
/api/rulesRecords/getRulesEventRecords
post
/api/rules/deleteRulePauseSetting
post
/api/rules/getRulePauseSettings
post
/api/rules/getRulesFiltered
post
/api/rules/getRulesForOrg
post
/api/rules/pauseRule
post
/api/rules/updateRule
post
Rules Records Webservice
/api/rulesRecords/getLatestRulesEventRecords
post
Schedule Webservice
/api/schedule/createAbsoluteSchedule
post
/api/schedule/createRelativeDateTimeIntervalsSchedule
post
/api/schedule/createRelativeSchedule
post
/api/schedule/createWeeklySchedule
post
/api/schedule/deleteSchedule
post
/api/schedule/findAbsoluteSchedule
post
/api/schedule/findRelativeDateTimeIntervalsSchedule
post
/api/schedule/findRelativeSchedule
post
/api/schedule/findWeeklySchedule
post
/api/schedule/getScheduleData
post
/api/schedule/getScheduleDataV2
post
/api/schedule/getSchedules
post
Search Webservice
/api/search/searchLicensePlates
post
/api/search/searchObjectsByColor
post
Sensor Webservice
/api/sensors/getFootageSensorSeekpointsForCamera
post
/api/sensors/getFootageSensorSeekpointsForLocation
post
/api/sensors/getFootageSensorSeekpointsForSensor
post
TvOs Config Webservice
/api/tvos/getTvOsConfig
post
/api/tvos/getTvOsConfigsForOrg
post
/api/tvos/updateTvOsConfig
post
Upload Webservice
/api/upload/badgeTemplate/images
post
/api/upload/bulkUploadUserProfilePhotos
post
/api/upload/companyLogo
post
/api/upload/floorplan
post
/api/upload/keypadLogo
post
/api/upload/rhombusKeyLogo
post
User Webservice
/api/user/assignEmailToUser
post
/api/user/createUser
post
/api/user/deleteUser
post
/api/user/getPartnerUsersInOrg
post
/api/user/getUsersInOrg
post
/api/user/updatePartnerUserNotificationSettings
post
/api/user/updateRhombusKeySettingsForUser
post
/api/user/updateUser
post
/api/user/updateUserNotificationSettings
post
/api/user/updateUserSelective
post
User Metadata Webservice
/api/user/metadata/createUserMetadataFieldTemplate
post
/api/user/metadata/deleteUserMetadataField
post
/api/user/metadata/deleteUserMetadataFieldTemplate
post
/api/user/metadata/findUserMetadataFieldTemplates
post
/api/user/metadata/findUserMetadataFields
post
/api/user/metadata/saveUserMetadataFields
post
/api/user/metadata/updateUserMetadataFieldTemplate
post
Vehicle Webservice
/api/vehicle/addVehicleLabel
post
/api/vehicle/associateEventsToVehicle
post
/api/vehicle/deleteVehicle
post
/api/vehicle/getRecentVehicleEvents
post
/api/vehicle/getRecentVehicleEventsByLocation
post
/api/vehicle/getRecentVehicleEventsForVehicle
post
/api/vehicle/getVehicleEvents
post
/api/vehicle/getVehicleLabelsForOrg
post
/api/vehicle/getVehicles
post
/api/vehicle/removeVehicleLabel
post
/api/vehicle/reportVehicleEvent
post
/api/vehicle/saveVehicle
post
Video Webservice
/api/video/cancelSplice
post
/api/video/cancelSpliceV2
post
/api/video/createSharedTimelapseGroup
post
/api/video/deleteSharedTimelapseGroup
post
/api/video/deleteTimelapseClips
post
/api/video/generateTimelapseClip
post
/api/video/getExactFrameUri
post
/api/video/getMaxSpliceDuration
post
/api/video/getSharedTimelapseGroups
post
/api/video/getSplicedClipsInProgress
post
/api/video/getTimelapseClips
post
/api/video/getTimelapseMetadata
post
/api/video/retrySplice
post
/api/video/shareTimelapseClips
post
/api/video/splice
post
/api/video/spliceFrame
post
/api/video/spliceV2
post
/api/video/spliceV3
post
/api/video/updateSharedTimelapseGroup
post
AudioPlayback Webservice
/api/audioplayback/cancelLoopingAudioPlayback
post
/api/audioplayback/deleteAudioUploadMetadata
post
/api/audioplayback/getAudioUploadMetadataForOrg
post
/api/audioplayback/playAudioUpload
post
/api/audioplayback/updateAudioUploadMetadata
post
/api/audioplayback/uploadAudioText
post
Face Recognition Event Webservice
/api/faceRecognition/faceEvent/deleteFaceEvent
post
/api/faceRecognition/faceEvent/findFaceEventsByOrg
post
/api/faceRecognition/faceEvent/getFaceEvent
post
/api/faceRecognition/faceEvent/updateFaceEvent
post
Face Recognition Matchmaker Webservice
/api/faceRecognition/matchmaker/createFaceMatchmakerFromSighting
post
/api/faceRecognition/matchmaker/deleteFaceMatchmaker
post
/api/faceRecognition/matchmaker/findFaceMatchmakersByOrg
post
/api/faceRecognition/matchmaker/findFaceMatchmakersByPerson
post
/api/faceRecognition/matchmaker/findFaceUploadMetadataByTransaction
post
/api/faceRecognition/matchmaker/getFaceMatchingConfig
post
/api/faceRecognition/matchmaker/getFaceMatchmaker
post
/api/faceRecognition/matchmaker/updateFaceMatchingConfig
post
/api/faceRecognition/matchmaker/uploadFaceMatchmakers
post
Face Recognition Person Webservice
/api/faceRecognition/person/addPersonLabel
post
/api/faceRecognition/person/createPerson
post
/api/faceRecognition/person/deletePerson
post
/api/faceRecognition/person/findPeopleByOrg
post
/api/faceRecognition/person/findPersonLabelsByOrg
post
/api/faceRecognition/person/getPerson
post
/api/faceRecognition/person/removePersonLabel
post
/api/faceRecognition/person/updatePerson
post
/api/internal/parentLifetimeSpend
post
post
/api/help/feedback
post
https://api2.rhombussystems.com/api/help/feedback
Leave feedback of our system
Language
Shell
Node
Python
Java
Credentials
Header
Header
RESPONSE
Click
Try It!
to start a request and see the response here!