Rhombus Systems Org Webservice API
The Org Webservice API from Rhombus Systems — 47 operation(s) for org webservice.
Rhombus Systems Org Webservice API is one of 65 APIs that Rhombus Systems publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Org Webservice. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 47 operations across 47 paths, and defines 200 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against a single base URL, https://api2.rhombussystems.com.
47 operations
47 paths
200 schemas
47 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Rhombus Systems Org Webservice API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as x-auth-apikey (ApiKeyAuth).
By default, every request must be authenticated.
ApiKeyAuth— Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).
Paths & Operations 47
Across 47 paths, the API surfaces 47 operations — 47 POST. Each is listed below with its method, path, parameters, and response codes.
Org Webservice 47
POST
/api/org/claimActivationToken
Claim activation token
POST
/api/org/claimShipmentRegistrationToken
Claim shipment registration token
POST
/api/org/createOrUpdateHealthNotificationRule
Create or update health notification rule
POST
/api/org/createPendingRegistration
Create pending registration
POST
/api/org/deleteCloudArchivingConfig
Delete cloud archiving config
POST
/api/org/deleteHealthNotificationRule
Delete health notification rule
POST
/api/org/deleteKeypadLogo
Delete keypad logo
POST
/api/org/deleteRhombusKeyLogo
Delete rhombus key logo
POST
/api/org/findAllHardwareWithPendingRegistration
Find all hardware with pending registration
POST
/api/org/findHardwareAvailableForPendingRegistration
Find hardware available for pending registration
POST
/api/org/findIfTeamNameAvailable
Find if team name available
POST
/api/org/findSCIMSettingsForOrg
Find SCIM settings for organization
POST
/api/org/generateFederatedSessionToken
Generate federated session token
POST
/api/org/getClientOrg
Get client organization details
POST
/api/org/getCloudArchivingConfigs
Get cloud archiving configs
POST
/api/org/getFeatures
Get organization features
POST
/api/org/getHealthNotificationRules
Get health notification rules
POST
/api/org/getOrgdeprecated
Get organization details
POST
/api/org/getOrgIntegrationsdeprecated
Get organization integrations
POST
/api/org/getOrgNotificationTemplatedeprecated
Get organization notification template
POST
/api/org/getOrgNotificationTemplateV2
Get organization notification template V2
POST
/api/org/getOrgV2
Get organization details V2
POST
/api/org/getSAMLSettingsdeprecated
Get SAML settings
POST
/api/org/getSAMLSettingsV2
Get SAML settings V2
POST
/api/org/getScimDisplayInfo
Get SCIM display info
POST
/api/org/getTemporaryOrgToken
Get temporary org token
POST
/api/org/peekShipmentRegistrationToken
Peek shipment registration token
POST
/api/org/removePendingRegistration
Remove pending registration
POST
/api/org/revokeSCIMAccessForOrg
Revoke SCIM access for organization
POST
/api/org/setupSCIMAccessForOrg
Setup SCIM access for organization
POST
/api/org/updateAiTrainingSettings
Update AI training settings
POST
/api/org/updateCloudArchivingConfig
Update cloud archiving config
POST
/api/org/updateFirmwareSettings
Update firmware settings
POST
/api/org/updateGeneralSettings
Update general settings
POST
/api/org/updateLoginIpAllowlist
Update login IP allowlist
POST
/api/org/updateMFASettings
Update MFA settings
POST
/api/org/updateOrgdeprecated
Update organization details
POST
/api/org/updateOrgAudioAnalysisPolicy
Update organization AI audio analysis policy
POST
/api/org/updateOrgAudioRecordingPolicy
Update organization audio recording policy
POST
/api/org/updateOrgLLMUsagePolicy
Update organization's LLM usage opt-in policy
POST
/api/org/updateOrgNotificationTemplatedeprecated
Update organization notification template
POST
/api/org/updateOrgNotificationTemplateV2
Update organization notification template V2
POST
/api/org/updatePaneLinks
Update the PANE apps this org links
POST
/api/org/updatePendingRegistration
Update pending registration
POST
/api/org/updateSAMLSettingsdeprecated
Update SAML settings
POST
/api/org/updateSAMLSettingsV2
Update SAML settings V2
POST
/api/org/updateSCIMSettingsForOrg
Update SCIM settings for organization
Schemas 200
The contract defines 200 schemas that model the data the API accepts and returns. The most detailed are OrgV2Type (57 properties), OrgIntegrationsType (38 properties), OrgType (27 properties), HaloSettings (21 properties). Each schema is shown below with its type and property counts.
Org_FindSCIMSettingsForOrgWSResponse
object
Response object containing SCIM settings for organization.
1 property
Org_GetFeaturesWSResponse
object
Response object containing organization feature flags.
14 properties
EnvoyLocationInfoType
objectnull
2 properties
Org_UpdateSCIMSettingsForOrgWSResponse
object
Response object for updating SCIM settings for organization.
3 properties
PlanTypeEnum
string
Org_RemovePendingRegistrationRequest
object
1 property
PlaceOsSettings
object
13 properties
CloudArchivingStrategyEnum
string
Org_PeekShipmentRegistrationTokenWSResponse
object
4 properties
DeviceTargetScopeEnum
string
ToastSettings
object
Toast POS integration settings to update
8 properties
ToastRestaurantInfo
object
A HashMap of . This stores the information for each restaurant.
2 properties
FirmwareUpdateModeEnum
string
Org_GetSAMLSettingsWSRequest
object
Request object for getting SAML settings (deprecated).
Org_UpdateCloudArchivingConfigWSRequest
object
Request object for updating cloud archiving configuration.
1 property
FirmwareUpdateSettingsType
objectnull
2 properties
Org_GetOrgNotificationTemplateWSRequest
object
Request object for getting organization notification template.
Org_UpdateOrgNotificationTemplateV2WSResponse
object
3 properties
Org_SetupSCIMAccessForOrgWSResponse
object
Response object for setting up SCIM access for organization.
2 properties
ButterflyMXSettings
object
12 properties
Org_UpdateLoginIpAllowlistWSRequest
object
Request object for updating the org-wide login IP allowlist.
1 property
Org_GetScimDisplayInfoResponse
object
Response object containing SCIM display information.
2 properties
Org_DeleteHealthNotificationRuleWSRequest
object
Request object for deleting a health notification rule.
1 property
NotificationTimeFrame
object
4 properties
TritonSettings
object
19 properties
OpenpathSettings
object
17 properties
OpentechAllianceDoorInfoType
objectnull
8 properties
Org_UpdateSAMLSettingsV2WSRequest
object
Request object for updating SAML settings V2.
1 property
NoonlightSettings
object
10 properties
Org_DeleteCloudArchivingConfigWSRequest
object
Request object for deleting cloud archiving configuration.
2 properties
OrgPaneLinkType
objectnull
5 properties
Org_ClaimShipmentRegistrationTokenWSResponse
object
3 properties
RBACSettingsType
object
1 property
ActivityEnum
string
Org_RevokeSCIMAccessForOrgWSResponse
object
Response object for revoking SCIM access for organization.
OrgSamlSettingsType
object
List of SAML settings to update
10 properties
Org_GetFeaturesWSRequest
object
Request object for getting organization features.
Org_UpdateCloudArchivingConfigWSResponse
object
Response object for updating cloud archiving configuration.
3 properties
Org_FindIfTeamNameAvailableResponse
object
Response object indicating if a team name is available.
1 property
Org_UpdatePendingRegistrationRequest
object
4 properties
BackblazeSettings
object
4 properties
Org_UpdatePaneLinksWSRequest
object
Request object for setting which PANE apps this organization links.
1 property
Device_config_settings_VideoConfigurationDefault
object
Map of hardware variations to default video configurations
6 properties
UserInfo
object
A HashMap of . This stores the information for each Slack user.
2 properties
TriggerContent
object
10 properties
Org_DeleteHealthNotificationRuleWSResponse
object
Response object for deleting a health notification rule.
3 properties
Org_GetHealthNotificationRulesWSResponse
object
Response object containing health notification rules for the organization.
4 properties
SCIMSettingsType
object
9 properties
Org_CreateOrUpdateHealthNotificationRuleWSRequest
object
Request object for creating or updating a health notification rule.
1 property
Org_FindHardwareAvailableForPendingRegistrationRequest
object
RhombusSecureMobileCredentialProvisioningRulesType
object
3 properties
MinuteOfDayIntervalType
object
3 properties
RhombusDayOfWeekEnum
string
PlayerViewLiveTypeEnum
string
EpochSecondsProvisioner
object
1 property
1 required
HaloSettings
object
21 properties
Org_UpdatePaneLinksWSResponse
object
Response object for setting which PANE apps this organization links.
3 properties
Org_UpdateOrgAudioRecordingPolicyWSRequest
object
Request object for updating organization audio recording policy.
1 property
Org_UpdateAiTrainingSettingsWSRequest
object
Request object for updating AI training settings.
1 property
ButterflymxPanelInfoType
objectnull
A HashMap of .
5 properties
OpentechAllianceSettings
object
8 properties
HealthNotificationRuleType
object
List of health notification rules
11 properties
Org_HardwareWithPendingRegistrationInfoType
object
3 properties
Org_UpdateOrgLLMUsagePolicyWSResponse
object
Response object for updating organization LLM usage opt-in policy.
3 properties
Org_GetTemporaryOrgTokenWSRequest
object
Request object for getting temporary organization token.
Org_GetSAMLSettingsWSResponse
object
Response object containing SAML settings (deprecated).
4 properties
Org_UpdateGeneralSettingsWSResponse
object
Response object for updating general organization settings.
3 properties
Org_DeleteRhombusKeyLogoWSRequest
object
Request object for deleting Rhombus Key logo.
3 properties
Org_GenerateFederatedSessionTokenResponse
object
Response object containing the generated federated session token.
1 property
Org_UpdateOrgWSResponse
object
Response object for updating organization details (deprecated).
3 properties
UserPermissionGroupType
object
Updated permission group configuration
20 properties
DiceSettings
object
4 properties
Org_UpdateOrgNotificationTemplateWSRequest
object
Request object for updating organization notification template.
2 properties
UAPSettingsType
objectnull
2 properties
Org_UpdateSAMLSettingsWSResponse
object
Response object for updating SAML settings (deprecated).
3 properties
Org_SetupSCIMAccessForOrgWSRequest
object
Request object for setting up SCIM access for organization.
4 properties
Org_CreateOrUpdateHealthNotificationRuleWSResponse
object
Response object for creating or updating a health notification rule.
4 properties
Org_FindHardwareAvailableForPendingRegistrationResponse
object
1 property
Org_UpdateLoginIpAllowlistWSResponse
object
Response object for updating the org-wide login IP allowlist.
4 properties
OrgType
object
Organization information to update
27 properties
Org_FindIfTeamNameAvailableRequest
object
Request object for checking if a team name is available.
1 property
SlackSettings
object
4 properties
PosIntegrationInfoType
object
A HashMap of . This stores the Pos Information and assigned cameras.
2 properties
Org_UpdatePendingRegistrationResponse
object
3 properties
WebhookMapEntry
objectnull
2 properties
Org_GetClientOrgWSResponse
object
Response object containing client organization details.
3 properties
Org_UpdateOrgAudioRecordingPolicyWSResponse
object
Response object for updating organization audio recording policy.
3 properties
Org_PendingRegistrationInfoType
object
3 properties
DeviceTypeEnum
string
WebhookSettings
object
Webhook integration settings to update
6 properties
Org_GetClientOrgWSRequest
object
Request object for getting client organization details.
1 property
Org_UpdateGeneralSettingsWSRequest
object
Request object for updating general organization settings.
10 properties
Org_GetOrgNotificationTemplateV2WSResponse
object
Response object containing organization notification template V2.
4 properties
Org_DeleteRhombusKeyLogoWSResponse
object
Response object for deleting Rhombus Key logo.
3 properties
PermissionEnum
string
Org_GetOrgWSResponse
object
Response object containing organization details (deprecated).
5 properties
Org_GetOrgWSRequest
object
Request object for getting organization details (deprecated).
Org_UpdateAiTrainingSettingsWSResponse
object
Response object for updating AI training settings.
3 properties
SubscriptionTypeEnum
string
BrivoSettings
object
19 properties
Org_PeekShipmentRegistrationTokenWSRequest
object
1 property
GoogleSettings
object
Google integration settings to update
7 properties
Org_GetOrgIntegrationsWSRequest
object
Request object for getting organization integrations (deprecated, use integration package).
Org_GetOrgIntegrationsWSResponse
object
Response object containing organization integrations (deprecated, use integration package).
4 properties
NotificationIntervalV2Type
object
9 properties
UserNotificationSettingsV4Type
object
List of user notification settings (V4)
7 properties
AwsSettings
object
7 properties
BadgeIntegrationDefaultOptions
objectnull
6 properties
FirmwareUpdateIntervalType
objectnull
2 properties
Org_UpdateFirmwareSettingsWSResponse
object
Response object for updating firmware settings.
3 properties
AlertMonitoringPinType
object
3 properties
StaticEpochSecondsProvisioner
objectnull
1 property
OrgTypeEnum
string
NotificationSettingsType
object
4 properties
Org_UpdateSAMLSettingsWSRequest
object
Request object for updating SAML settings (deprecated).
1 property
SlackSettingsV2
object
12 properties
Org_GetOrgNotificationTemplateWSResponse
object
Response object containing organization notification template.
4 properties
HardwareType
object
17 properties
FirmwareUpdateSettingsOverrideType
objectnull
Overrides default firmware update settings.
2 properties
UserNotificationSelectiveUpdateV2
object
Template update configuration
8 properties
FunctionalityEnum
string
EmergencyResponseContactsIntervalType
object
3 properties
BoxSettings
object
Box file storage integration settings to update
6 properties
Org_DeleteKeypadLogoWSResponse
object
Response object for deleting keypad logo.
3 properties
Org_CreatePendingRegistrationRequest
object
Request object for creating pending hardware registration.
5 properties
SubscriptionStatusEnum
string
Org_GetSAMLSettingsV2WSRequest
object
Request object for getting SAML settings V2.
NotificationEnumType
string
OrgIntegrationsType
object
Organization integrations configuration and settings
38 properties
Org_GetOrgV2WSResponse
object
Response object containing organization details V2 with camera configuration options.
7 properties
EnvoySettings
object
Envoy visitor management integration settings to update
11 properties
AlertMonitoringSubmissionDelayIntervalType
object
4 properties
Org_RemovePendingRegistrationResponse
object
Org_ClaimActivationTokenWSRequest
object
3 properties
Org_GenerateFederatedSessionTokenRequest
object
Request object for generating a federated session token.
3 properties
EmergencyContact
object
2 properties
2 required
RhombusKeyAppSettingsType
object
4 properties
MattermostSettings
object
6 properties
GoogleSettingsV2
object
11 properties
HardwareVariationEnum
string
IntuifaceSettings
object
5 properties
HealthNotificationConditionTypeEnum
string
Org_CreatePendingRegistrationResponse
object
Response object for creating pending hardware registration.
3 properties
MicrosoftTeamsSettings
object
5 properties
Org_UpdateSCIMSettingsForOrgWSRequest
object
Request object for updating SCIM settings for organization.
4 properties
Org_FindAllHardwareWithPendingRegistrationResponse
object
2 properties
DropboxSettingsV2
object
Dropbox integration settings to update
7 properties
PagerDutySettings
object
7 properties
Org_UpdateSAMLSettingsV2WSResponse
object
Response object for updating SAML settings V2.
3 properties
Org_GetCloudArchivingConfigsWSRequest
object
Request object for getting cloud archiving configurations.
Device_config_settings_IntRange
object
2 properties
NoonlightPromptThemeEnum
string
BadgeIntegrationSettings
objectnull
11 properties
Org_UpdateMFASettingsWSRequest
object
Request object for updating MFA settings.
2 properties
Device_config_settings_ExternalVideoResolution
object
2 properties
Org_GetCloudArchivingConfigsWSResponse
object
Response object containing cloud archiving configurations.
4 properties
Org_GetHealthNotificationRulesWSRequest
object
Request object for getting health notification rules.
SaltoSettings
object
6 properties
Org_UpdateOrgWSRequest
object
Request object for updating organization details (deprecated).
1 property
Org_DeleteKeypadLogoWSRequest
object
Request object for deleting keypad logo.
Org_UpdateOrgNotificationTemplateV2WSRequest
object
Request object for updating organization notification template V2.
2 properties
TwilioSettings
object
2 properties
SquareSettings
object
2 properties
Org_DeviceRegistrationClaimType
object
4 properties
TPLinkSettings
object
6 properties
Device_config_settings_VideoConfigurationOption
object
Map of hardware variations to available video configuration options
4 properties
DiagnosticActivityEnum
string
ServiceNowSettings
object
7 properties
AmtSettings
object
14 properties
OrgV2Type
objectnull
List of Rhombus organizations the user has access to
57 properties
SAMLSettingsType
object
4 properties
Org_ClaimShipmentRegistrationTokenWSRequest
object
2 properties
ImmixSettings
object
3 properties
Org_RevokeSCIMAccessForOrgWSRequest
object
Request object for revoking SCIM access for organization.
UserNotificationSettingsV3Type
object
List of user notification settings (V3)
5 properties
SCIMRolesFormatEnum
string
Org_UpdateOrgLLMUsagePolicyWSRequest
object
Request object for updating organization LLM usage opt-in policy.
1 property
Org_UpdateMFASettingsWSResponse
object
Response object for updating MFA settings.
4 properties
Org_GetSAMLSettingsV2WSResponse
object
Response object containing SAML settings V2.
4 properties
Org_UpdateOrgAudioAnalysisPolicyWSRequest
object
Request object for updating organization audio analysis policy.
1 property
Org_FindAllHardwareWithPendingRegistrationRequest
object
Org_GetOrgV2WSRequest
object
Request object for getting organization details V2.
Org_UpdateOrgNotificationTemplateWSResponse
object
Response object for updating organization notification template.
3 properties
Org_FindSCIMSettingsForOrgWSRequest
object
Request object for finding SCIM settings for organization.
ProDataKeySettings
object
16 properties
Office365Settings
object
Office 365 integration settings to update
6 properties
Org_UpdateOrgAudioAnalysisPolicyWSResponse
object
Response object for updating organization audio analysis policy.
3 properties
KisiSettings
object
18 properties
GetTemporaryOrgTokenResponse
object
1 property
Org_ClaimActivationTokenWSResponse
object
3 properties
NotificationTimeFrameRow
object
8 properties
BadgeIntegrationDoorInfoType
objectnull
7 properties
Org_UpdateFirmwareSettingsWSRequest
object
Request object for updating firmware settings.
3 properties
ScopedCloudArchivingConfig
object
Cloud archiving configuration to update
6 properties
RhombusSamlDomainEnum
string
EmailSettings
object
5 properties
Org_DeleteCloudArchivingConfigWSResponse
object
Response object for deleting cloud archiving configuration.
3 properties
GeneaSettings
object
14 properties
OpentechAllianceFacilitySettings
objectnull
5 properties
LumeoSettings
object
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Rhombus Systems 12
Other APIs Rhombus Systems publishes across the network.
Rhombus Console WebSocket API
Rhombus Systems Access Control Integrations Webservice API
Rhombus Systems Access Control Webservice API
Rhombus Systems Alarm Monitoring Keypad Webservice API
Rhombus Systems Alert Monitoring Webservice API
Rhombus Systems AudioGateway Webservice API
Rhombus Systems AudioPlayback Webservice API
Rhombus Systems Badge Reader Webservice API
Rhombus Systems BLE Webservice API
Rhombus Systems Button Webservice API
Rhombus Systems Camera Webservice API
Rhombus Systems ClaimKey Webservice API
#Org Webservice
Where this information came from
This is an independent, third-party profile of Rhombus Systems Org Webservice API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.