# Rhombus Developer Documentation: English API Reference

> Developer documentation for the Rhombus API — cameras, access control, sensors, and security platform integrations.

## API Reference

- [English / API Reference / Access Control Webservice (65 pages)](https://api-docs.rhombus.community/_llms/en/api-reference/access-control-webservice.md): Documentation for English / API Reference / Access Control Webservice.
- [English / API Reference / Camera Webservice (61 pages)](https://api-docs.rhombus.community/_llms/en/api-reference/camera-webservice.md): Documentation for English / API Reference / Camera Webservice.
- [English / API Reference / Component Webservice (62 pages)](https://api-docs.rhombus.community/_llms/en/api-reference/component-webservice.md): Documentation for English / API Reference / Component Webservice.
- [English / API Reference / Event Webservice (42 pages)](https://api-docs.rhombus.community/_llms/en/api-reference/event-webservice.md): Documentation for English / API Reference / Event Webservice.
- [English / API Reference / Access Control Integrations Webservice (101 pages)](https://api-docs.rhombus.community/_llms/en/api-reference/access-control-integrations-webservice.md): Documentation for English / API Reference / Access Control Integrations Webservice.
- [English / API Reference / Incident Management Integrations Webservice (34 pages)](https://api-docs.rhombus.community/_llms/en/api-reference/incident-management-integrations-webservice.md): Documentation for English / API Reference / Incident Management Integrations Webservice.
- [English / API Reference / Org Webservice (47 pages)](https://api-docs.rhombus.community/_llms/en/api-reference/org-webservice.md): Documentation for English / API Reference / Org Webservice.
- [English / API Reference / Policy Webservice (54 pages)](https://api-docs.rhombus.community/_llms/en/api-reference/policy-webservice.md): Documentation for English / API Reference / Policy Webservice.

### Overview

- [API Reference](https://api-docs.rhombus.community/api-reference/overview.md): Complete REST API reference covering 900+ Rhombus endpoints for cameras, access control, sensors, alarms, video streaming, and analytics.

### Lockdown Plan Webservice

- [Activate lockdown for the specified location](https://api-docs.rhombus.community/api-reference/lockdown-plan-webservice/activate-lockdown-for-the-specified-location.md): Activate lockdown for the specified location
- [Create location lockdown plan](https://api-docs.rhombus.community/api-reference/lockdown-plan-webservice/create-location-lockdown-plan.md): Create location lockdown plan
- [Create lockdown rule for location](https://api-docs.rhombus.community/api-reference/lockdown-plan-webservice/create-lockdown-rule-for-location.md): Create (or update if ruleUuid is provided) a lockdown rule for the specified location
- [Deactivate lockdown for the specified location](https://api-docs.rhombus.community/api-reference/lockdown-plan-webservice/deactivate-lockdown-for-the-specified-location.md): Deactivate lockdown for the specified location
- [Delete location lockdown state](https://api-docs.rhombus.community/api-reference/lockdown-plan-webservice/delete-location-lockdown-state.md): Disables tracking lockdown state for the specified location
- [Delete lockdown plan](https://api-docs.rhombus.community/api-reference/lockdown-plan-webservice/delete-lockdown-plan.md): Delete lockdown plan
- [Delete lockdown rule for location](https://api-docs.rhombus.community/api-reference/lockdown-plan-webservice/delete-lockdown-rule-for-location.md): Delete a lockdown rule for the specified location
- [Disable test mode of lockdown for the specified location](https://api-docs.rhombus.community/api-reference/lockdown-plan-webservice/disable-test-mode-of-lockdown-for-the-specified-location.md): Disable test mode of lockdown for the specified location
- [Enable test mode of lockdown for the specified location](https://api-docs.rhombus.community/api-reference/lockdown-plan-webservice/enable-test-mode-of-lockdown-for-the-specified-location.md): Enable test mode of lockdown for the specified location
- [Find location lockdown events](https://api-docs.rhombus.community/api-reference/lockdown-plan-webservice/find-location-lockdown-events.md): Retrieve a list of lockdown events for the specified location
- [Find location lockdown states](https://api-docs.rhombus.community/api-reference/lockdown-plan-webservice/find-location-lockdown-states.md): Finds the state of all lockdowns for the org
- [Find lockdown plans in the org](https://api-docs.rhombus.community/api-reference/lockdown-plan-webservice/find-lockdown-plans-in-the-org.md): Find lockdown plans in the org
- [Find lockdown plans for the specified location](https://api-docs.rhombus.community/api-reference/lockdown-plan-webservice/find-lockdown-plans-for-the-specified-location.md): Find lockdown plans for the specified location
- [Get lockdown plan](https://api-docs.rhombus.community/api-reference/lockdown-plan-webservice/get-lockdown-plan.md): Get lockdown plan
- [Get lockdown rules for location](https://api-docs.rhombus.community/api-reference/lockdown-plan-webservice/get-lockdown-rules-for-location.md): Get lockdown activation / deactivation rules for a location
- [Get or create location lockdown state](https://api-docs.rhombus.community/api-reference/lockdown-plan-webservice/get-or-create-location-lockdown-state.md): Retrieves an existing lockdown state or creates one for the specified location
- [Update location lockdown plan](https://api-docs.rhombus.community/api-reference/lockdown-plan-webservice/update-location-lockdown-plan.md): Update location lockdown plan

### Alert Monitoring Webservice

- [Cancel threat case](https://api-docs.rhombus.community/api-reference/alert-monitoring-webservice/cancel-threat-case.md): Cancel a threat case in alert monitoring.
- [Create custom PIN for location](https://api-docs.rhombus.community/api-reference/alert-monitoring-webservice/create-custom-pin-for-location.md): Create a custom PIN for alert monitoring at a specific location.
- [Create PIN for location](https://api-docs.rhombus.community/api-reference/alert-monitoring-webservice/create-pin-for-location.md): Create a PIN for alert monitoring at a specific location.
- [Delete PIN for location](https://api-docs.rhombus.community/api-reference/alert-monitoring-webservice/delete-pin-for-location.md): Delete a PIN for alert monitoring at a specific location.
- [Disable monitoring for location](https://api-docs.rhombus.community/api-reference/alert-monitoring-webservice/disable-monitoring-for-location.md): Disable alert monitoring for a specific location.
- [Dismiss threat case](https://api-docs.rhombus.community/api-reference/alert-monitoring-webservice/dismiss-threat-case.md): Dismiss a threat case in alert monitoring.
- [Enable monitoring for location](https://api-docs.rhombus.community/api-reference/alert-monitoring-webservice/enable-monitoring-for-location.md): Enable alert monitoring for a specific location.
- [Escalate threat case to alarm](https://api-docs.rhombus.community/api-reference/alert-monitoring-webservice/escalate-threat-case-to-alarm.md): Escalate a threat case to an alarm for alert monitoring.
- [Get alert monitoring settings for location](https://api-docs.rhombus.community/api-reference/alert-monitoring-webservice/get-alert-monitoring-settings-for-location.md): Retrieve alert monitoring settings by location.
- [Get location status](https://api-docs.rhombus.community/api-reference/alert-monitoring-webservice/get-location-status.md): Retrieve summary of the alarm monitoring status for the specified location
- [Get organization status](https://api-docs.rhombus.community/api-reference/alert-monitoring-webservice/get-organization-status.md): Retrieve summary of the alarm monitoring status for all locations

### AudioGateway Webservice

- [Delete audio gateway](https://api-docs.rhombus.community/api-reference/audiogateway-webservice/delete-audio-gateway.md): Remove an audio gateway from organization
- [Get audio seek points](https://api-docs.rhombus.community/api-reference/audiogateway-webservice/get-audio-seek-points.md): Get audio seek points
- [Get audio gateway config](https://api-docs.rhombus.community/api-reference/audiogateway-webservice/get-audio-gateway-config.md): Get an audio gateway config
- [Get full audio gateway state](https://api-docs.rhombus.community/api-reference/audiogateway-webservice/get-full-audio-gateway-state.md): Get detailed information about state of specified audio gateway
- [Get media URIs for audio gateway](https://api-docs.rhombus.community/api-reference/audiogateway-webservice/get-media-uris-for-audio-gateway.md): Get media uris for audio gateway to retrieve footage
- [Get minimal audio gateway state list](https://api-docs.rhombus.community/api-reference/audiogateway-webservice/get-minimal-audio-gateway-state-list.md): Get basic state information for all audio gateways
- [Get audio gateway presence windows](https://api-docs.rhombus.community/api-reference/audiogateway-webservice/get-audio-gateway-presence-windows.md): Get stored video information for an audio gateway
- [Get audio gateway uptime windows](https://api-docs.rhombus.community/api-reference/audiogateway-webservice/get-audio-gateway-uptime-windows.md): Get uptime information for an audio gateway
- [Update audio gateway config](https://api-docs.rhombus.community/api-reference/audiogateway-webservice/update-audio-gateway-config.md): Update config for audio gateway
- [Update audio gateway details](https://api-docs.rhombus.community/api-reference/audiogateway-webservice/update-audio-gateway-details.md): Update details for audio gateway. Note: uuid is a required field

### AudioPlayback Webservice

- [Cancel looping audio playback](https://api-docs.rhombus.community/api-reference/audioplayback-webservice/cancel-looping-audio-playback.md): Cancel any currently playing looping audio for an audio device
- [Delete audio upload metadata](https://api-docs.rhombus.community/api-reference/audioplayback-webservice/delete-audio-upload-metadata.md): Delete an uploaded audio clip metadata
- [Get audio upload metadata for organization](https://api-docs.rhombus.community/api-reference/audioplayback-webservice/get-audio-upload-metadata-for-organization.md): Get list of uploaded audio clip metadata
- [Play audio upload](https://api-docs.rhombus.community/api-reference/audioplayback-webservice/play-audio-upload.md): Play an uploaded audio clip through an audio device
- [Update audio upload metadata](https://api-docs.rhombus.community/api-reference/audioplayback-webservice/update-audio-upload-metadata.md): Update an uploaded audio clip metadata
- [Upload text to synthesize audio](https://api-docs.rhombus.community/api-reference/audioplayback-webservice/upload-text-to-synthesize-audio.md): Upload text to synthesize audio

### Badge Reader Webservice

- [Delete badge reader](https://api-docs.rhombus.community/api-reference/badge-reader-webservice/delete-badge-reader.md): Remove the badge reader from the organization
- [Reboot badge reader](https://api-docs.rhombus.community/api-reference/badge-reader-webservice/reboot-badge-reader.md): Reboot the specified badge reader

### BLE Webservice

- [Get base stations](https://api-docs.rhombus.community/api-reference/ble-webservice/get-base-stations.md): Retrieve list of available base stations for BLE sensors

### Button Webservice

- [Create rule for button](https://api-docs.rhombus.community/api-reference/button-webservice/create-rule-for-button.md): Create rule for a button sensor.
- [Delete rule for button](https://api-docs.rhombus.community/api-reference/button-webservice/delete-rule-for-button.md): Delete rule for a button sensor.
- [Get button press events for sensor](https://api-docs.rhombus.community/api-reference/button-webservice/get-button-press-events-for-sensor.md): Get list of button press events for button sensor
- [Get button rules for organization](https://api-docs.rhombus.community/api-reference/button-webservice/get-button-rules-for-organization.md): Get rules for all buttons in an org.
- [Get minimal button state list](https://api-docs.rhombus.community/api-reference/button-webservice/get-minimal-button-state-list.md): Get basic state information for all button sensors
- [Get rules for button](https://api-docs.rhombus.community/api-reference/button-webservice/get-rules-for-button.md): Get all rules for a button sensor.
- [Update button config](https://api-docs.rhombus.community/api-reference/button-webservice/update-button-config.md): Update config for a button sensor.
- [Update button details](https://api-docs.rhombus.community/api-reference/button-webservice/update-button-details.md): Update details for a button sensor.

### Climate Webservice

- [Delete environmental gateway](https://api-docs.rhombus.community/api-reference/climate-webservice/delete-environmental-gateway.md): Remove an environmental gateway from the org
- [Get climate events for environmental sensor](https://api-docs.rhombus.community/api-reference/climate-webservice/get-climate-events-for-environmental-sensor.md): Get list of climate events for environmental sensor
- [Get climate presence windows](https://api-docs.rhombus.community/api-reference/climate-webservice/get-climate-presence-windows.md): Get stored video information for sensor
- [Get climate sensor config](https://api-docs.rhombus.community/api-reference/climate-webservice/get-climate-sensor-config.md): Get the config for a climate sensor
- [Get environmental gateway shadows](https://api-docs.rhombus.community/api-reference/climate-webservice/get-environmental-gateway-shadows.md): Get list of shadows of all environmental gateways of an org
- [Get events for environmental gateway](https://api-docs.rhombus.community/api-reference/climate-webservice/get-events-for-environmental-gateway.md): Get list of events for environmental gateway
- [Get minimal climate state list](https://api-docs.rhombus.community/api-reference/climate-webservice/get-minimal-climate-state-list.md): Get basic state information of all environmental sensors
- [Get minimal environmental gateway states](https://api-docs.rhombus.community/api-reference/climate-webservice/get-minimal-environmental-gateway-states.md): Get list of basic states of all environmental gateways of an org
- [Get minimal state events for environmental gateway](https://api-docs.rhombus.community/api-reference/climate-webservice/get-minimal-state-events-for-environmental-gateway.md): Get list of events for environmental gateways in minimal state
- [Reboot environmental gateway](https://api-docs.rhombus.community/api-reference/climate-webservice/reboot-environmental-gateway.md): Send reboot command to environmental gateway
- [Update climate sensor details](https://api-docs.rhombus.community/api-reference/climate-webservice/update-climate-sensor-details.md): Update details for environmental sensor. Note: uuid is a required field
- [Update environmental gateway details](https://api-docs.rhombus.community/api-reference/climate-webservice/update-environmental-gateway-details.md): Update details for environmental gateway. Note: uuid is a required field

### Elevator Webservice

- [Create a label that can be assigned to an access controlled elevator landing](https://api-docs.rhombus.community/api-reference/elevator-webservice/create-a-label-that-can-be-assigned-to-an-access-controlled-elevator-landing.md): Create a label that can be assigned to an access controlled elevator landing and referenced by an access grant or access revocation
- [Find access controlled elevator landing shadows within the org](https://api-docs.rhombus.community/api-reference/elevator-webservice/find-access-controlled-elevator-landing-shadows-within-the-org.md): Find access controlled elevator landing shadows within the org
- [Find access controlled elevator landing shadows within the specified location](https://api-docs.rhombus.community/api-reference/elevator-webservice/find-access-controlled-elevator-landing-shadows-within-the-specified-location.md): Find access controlled elevator landing shadows within the specified location
- [Find access controlled elevators landings within the specified location](https://api-docs.rhombus.community/api-reference/elevator-webservice/find-access-controlled-elevators-landings-within-the-specified-location.md): Find access controlled elevators landings within the specified location
- [Get all access controlled elevator landing labels for the organization](https://api-docs.rhombus.community/api-reference/elevator-webservice/get-all-access-controlled-elevator-landing-labels-for-the-organization.md): Get all access controlled elevator landing labels for the organization
- [Remove a label to an access controlled elevator landing](https://api-docs.rhombus.community/api-reference/elevator-webservice/remove-a-label-to-an-access-controlled-elevator-landing.md): Remove a label to an access controlled elevator landing

### Customer Webservice

- [Delete all notification snooze settings](https://api-docs.rhombus.community/api-reference/customer-webservice/delete-all-notification-snooze-settings.md): Delete a policy pause setting for a device
- [Delete a policy pause setting for a component composite](https://api-docs.rhombus.community/api-reference/customer-webservice/delete-a-policy-pause-setting-for-a-component-composite.md): Delete a policy pause setting for a component composite
- [Delete a policy pause setting for a device](https://api-docs.rhombus.community/api-reference/customer-webservice/delete-a-policy-pause-setting-for-a-device.md): Delete a policy pause setting for a device
- [Delete a policy pause setting for a location](https://api-docs.rhombus.community/api-reference/customer-webservice/delete-a-policy-pause-setting-for-a-location.md): Delete a policy pause setting for a location
- [Get the current and planned user notification snooze details](https://api-docs.rhombus.community/api-reference/customer-webservice/get-the-current-and-planned-user-notification-snooze-details.md): Get the current and planned user notification snooze details

### User Webservice

- [Update notification settings for user](https://api-docs.rhombus.community/api-reference/user-webservice/update-notification-settings-for-user.md): Update notification settings for user
- [Assign email to user](https://api-docs.rhombus.community/api-reference/user-webservice/assign-email-to-user.md): Assign a user to an email as long as the user is not currently assigned to one, with validation to prevent duplicate email associations.
- [Create user for organization](https://api-docs.rhombus.community/api-reference/user-webservice/create-user-for-organization.md): Create a user for organization with specified name, email, and role permissions, supporting both client and partner user types with proper validation and audit logging.
- [Delete user](https://api-docs.rhombus.community/api-reference/user-webservice/delete-user.md): Delete a user from the organization with proper validation to prevent deletion of the last super admin and current user.
- [Get partner users in organization](https://api-docs.rhombus.community/api-reference/user-webservice/get-partner-users-in-organization.md): Get list of all partners in organization with partner-specific user details and permissions.
- [Get users in organization](https://api-docs.rhombus.community/api-reference/user-webservice/get-users-in-organization.md): Get list of all users in organization with complete user details, permissions, notification settings, and partner information.
- [Update partner user details](https://api-docs.rhombus.community/api-reference/user-webservice/update-partner-user-details.md): Update a partner's details with partner-specific validation and audit logging.
- [Update partner user notification settings](https://api-docs.rhombus.community/api-reference/user-webservice/update-partner-user-notification-settings.md): Update notification settings for partner user with partner-specific notification configurations.
- [Update Rhombus key settings for user](https://api-docs.rhombus.community/api-reference/user-webservice/update-rhombus-key-settings-for-user.md): Update the RhombusKey mobile app settings for the user, including access permissions and app configuration.
- [Update user details](https://api-docs.rhombus.community/api-reference/user-webservice/update-user-details.md): Update a user's details, DEPRECATED[4/28/2025]: use updateUserSelective for better field-level control.
- [Update user notification settings](https://api-docs.rhombus.community/api-reference/user-webservice/update-user-notification-settings.md): Update notification settings for user with various notification channels and preferences.
- [Update user details selectively](https://api-docs.rhombus.community/api-reference/user-webservice/update-user-details-selectively.md): Selectively updates a user's details. Omitted fields are ignored but fields with null will unset a value, providing granular control over user updates.

### Developer Webservice

- [Create an event listener](https://api-docs.rhombus.community/api-reference/developer-webservice/create-an-event-listener.md): Create an event listener
- [Delete an event listener](https://api-docs.rhombus.community/api-reference/developer-webservice/delete-an-event-listener.md): Delete an event listener
- [Get a list of all event listeners](https://api-docs.rhombus.community/api-reference/developer-webservice/get-a-list-of-all-event-listeners.md): Get a list of all event listeners
- [Get a list of event listeners for a device](https://api-docs.rhombus.community/api-reference/developer-webservice/get-a-list-of-event-listeners-for-a-device.md): Get a list of event listeners for a device

### Device Config Webservice

- [Get a device's config](https://api-docs.rhombus.community/api-reference/device-config-webservice/get-a-devices-config.md): Get a device's config
- [Update a device's config](https://api-docs.rhombus.community/api-reference/device-config-webservice/update-a-devices-config.md): Update a device's config

### Door Webservice

- [Get list of door open/close events for door sensor](https://api-docs.rhombus.community/api-reference/door-webservice/get-list-of-door-openclose-events-for-door-sensor.md): Get list of door open/close events for door sensor
- [Get stored video information for sensor](https://api-docs.rhombus.community/api-reference/door-webservice/get-stored-video-information-for-sensor.md): Get stored video information for sensor
- [Get basic state information for all door sensors](https://api-docs.rhombus.community/api-reference/door-webservice/get-basic-state-information-for-all-door-sensors.md): Get basic state information for all door sensors
- [Update details for door sensor](https://api-docs.rhombus.community/api-reference/door-webservice/update-details-for-door-sensor.md): Update details for door sensor. Note: uuid is a required field

### Doorbell Camera Webservice

- [Generate the homography to project detections onto a floorplan](https://api-docs.rhombus.community/api-reference/doorbell-camera-webservice/generate-the-homography-to-project-detections-onto-a-floorplan.md): Generate the homography to project detections onto a floorplan.
- [Create rule for a doorbell camera](https://api-docs.rhombus.community/api-reference/doorbell-camera-webservice/create-rule-for-a-doorbell-camera.md): Create rule for a doorbell camera.
- [Share an live video stream for a doorbell camera](https://api-docs.rhombus.community/api-reference/doorbell-camera-webservice/share-an-live-video-stream-for-a-doorbell-camera.md): Share an live video stream for a doorbell camera
- [Remove the doorbell camera from the organization](https://api-docs.rhombus.community/api-reference/doorbell-camera-webservice/remove-the-doorbell-camera-from-the-organization.md): Remove the doorbell camera from the organization
- [Delete rule for a doorbell camera](https://api-docs.rhombus.community/api-reference/doorbell-camera-webservice/delete-rule-for-a-doorbell-camera.md): Delete rule for a doorbell camera.
- [Retrieve all component events relevant to the specified Doorbell Camera](https://api-docs.rhombus.community/api-reference/doorbell-camera-webservice/retrieve-all-component-events-relevant-to-the-specified-doorbell-camera.md): Retrieve all component events relevant to the specified Doorbell Camera
- [Retrieve all component seekpoints relevant to the specified Doorbell Camera](https://api-docs.rhombus.community/api-reference/doorbell-camera-webservice/retrieve-all-component-seekpoints-relevant-to-the-specified-doorbell-camera.md): Retrieve all component seekpoints relevant to the specified Doorbell Camera
- [Get list of all shared live streams for doorbell camera](https://api-docs.rhombus.community/api-reference/doorbell-camera-webservice/get-list-of-all-shared-live-streams-for-doorbell-camera.md): Get list of all shared live streams for doorbell camera
- [Get rules for all doorbell cameras in an org](https://api-docs.rhombus.community/api-reference/doorbell-camera-webservice/get-rules-for-all-doorbell-cameras-in-an-org.md): Get rules for all doorbell cameras in an org.
- [Get all rules for a doorbell camera](https://api-docs.rhombus.community/api-reference/doorbell-camera-webservice/get-all-rules-for-a-doorbell-camera.md): Get all rules for a doorbell camera.

### Door Controller Webservice

- [Register a Rhombus reader that a Door Controller has discovered](https://api-docs.rhombus.community/api-reference/door-controller-webservice/register-a-rhombus-reader-that-a-door-controller-has-discovered.md): Register a Rhombus reader that a Door Controller has discovered
- [Update details for door controller](https://api-docs.rhombus.community/api-reference/door-controller-webservice/update-details-for-door-controller.md): Update details for door controller. Note: uuid is a required field

### Event Search Webservice

- [Get camera or doorbell camera seekpoints](https://api-docs.rhombus.community/api-reference/event-search-webservice/get-camera-or-doorbell-camera-seekpoints.md): Get camera or doorbell camera seekpoints
- [Get normal seekpoint events and access control seekpoint events](https://api-docs.rhombus.community/api-reference/event-search-webservice/get-normal-seekpoint-events-and-access-control-seekpoint-events.md): Get normal seekpoint events and access control seekpoint events

### Export Webservice

- [Download audit log](https://api-docs.rhombus.community/api-reference/export-webservice/download-audit-log.md): Download audit log
- [Download climate event log](https://api-docs.rhombus.community/api-reference/export-webservice/download-climate-event-log.md): Download climate event log
- [Download count report](https://api-docs.rhombus.community/api-reference/export-webservice/download-count-report.md): Download count report
- [Download diagnostic log](https://api-docs.rhombus.community/api-reference/export-webservice/download-diagnostic-log.md): Download diagnostic log
- [Download door event log](https://api-docs.rhombus.community/api-reference/export-webservice/download-door-event-log.md): Download door event log
- [Download environmental gateway event log](https://api-docs.rhombus.community/api-reference/export-webservice/download-environmental-gateway-event-log.md): Download environmental gateway event log
- [Download device inventory](https://api-docs.rhombus.community/api-reference/export-webservice/download-device-inventory.md): Download device inventory
- [Download motion event log for motion sensors](https://api-docs.rhombus.community/api-reference/export-webservice/download-motion-event-log-for-motion-sensors.md): Download motion event log for motion sensors
- [Download people count report](https://api-docs.rhombus.community/api-reference/export-webservice/download-people-count-report.md): Download people count report
- [Download people event log](https://api-docs.rhombus.community/api-reference/export-webservice/download-people-event-log.md): Download people event log
- [Download proximity tag event log](https://api-docs.rhombus.community/api-reference/export-webservice/download-proximity-tag-event-log.md): Download proximity tag event log
- [Download proximity tag event log](https://api-docs.rhombus.community/api-reference/export-webservice/download-proximity-tag-event-log-1.md): Download proximity tag event log
- [Download device uptime reports](https://api-docs.rhombus.community/api-reference/export-webservice/download-device-uptime-reports.md): Download device uptime reports
- [Download org users](https://api-docs.rhombus.community/api-reference/export-webservice/download-org-users.md): Download org users
- [Download vehicle event log](https://api-docs.rhombus.community/api-reference/export-webservice/download-vehicle-event-log.md): Download vehicle event log.  Use /export/vehicleEventsV2 instead for more functionality
- [Download vehicle event log](https://api-docs.rhombus.community/api-reference/export-webservice/download-vehicle-event-log-1.md): Download vehicle event log

### Face Recognition Event Webservice

- [Delete face event](https://api-docs.rhombus.community/api-reference/face-recognition-event-webservice/delete-face-event.md): Delete face event.
- [Find face events by organization](https://api-docs.rhombus.community/api-reference/face-recognition-event-webservice/find-face-events-by-organization.md): Find face events for an organization. The events are returned in reverse chronological order, with the latest events appearing first.
- [Get face event](https://api-docs.rhombus.community/api-reference/face-recognition-event-webservice/get-face-event.md): Get face event.
- [Update face event](https://api-docs.rhombus.community/api-reference/face-recognition-event-webservice/update-face-event.md): Update face event.

### Face Recognition Matchmaker Webservice

- [Create face matchmaker from sighting](https://api-docs.rhombus.community/api-reference/face-recognition-matchmaker-webservice/create-face-matchmaker-from-sighting.md): Create face matchmaker from face sighting.
- [Delete face matchmaker](https://api-docs.rhombus.community/api-reference/face-recognition-matchmaker-webservice/delete-face-matchmaker.md): Delete face matchmaker.
- [Find face matchmakers by org](https://api-docs.rhombus.community/api-reference/face-recognition-matchmaker-webservice/find-face-matchmakers-by-org.md): Find face matchmakers by org.
- [Find face matchmakers by person](https://api-docs.rhombus.community/api-reference/face-recognition-matchmaker-webservice/find-face-matchmakers-by-person.md): Find face matchmakers by person.
- [Find face upload metadata by transaction](https://api-docs.rhombus.community/api-reference/face-recognition-matchmaker-webservice/find-face-upload-metadata-by-transaction.md): Find face upload metadata by transaction.
- [Get face matching configuration](https://api-docs.rhombus.community/api-reference/face-recognition-matchmaker-webservice/get-face-matching-configuration.md): Get face matching configuration.
- [Get face matchmaker](https://api-docs.rhombus.community/api-reference/face-recognition-matchmaker-webservice/get-face-matchmaker.md): Get face matchmaker.
- [Update face matching configuration](https://api-docs.rhombus.community/api-reference/face-recognition-matchmaker-webservice/update-face-matching-configuration.md): Update face matching configuration.
- [Upload face matchmakers](https://api-docs.rhombus.community/api-reference/face-recognition-matchmaker-webservice/upload-face-matchmakers.md): Upload face matchmaker images for one or more people. The uploaded file name is matched to a person's name. If a person is not found and createPersonIfNotFound is set to true, a new person is created.

### Face Recognition Person Webservice

- [Add a label to a person](https://api-docs.rhombus.community/api-reference/face-recognition-person-webservice/add-a-label-to-a-person.md): Add a label to a person
- [Create a person](https://api-docs.rhombus.community/api-reference/face-recognition-person-webservice/create-a-person.md): Create a person for face recognition purposes.
- [Delete person](https://api-docs.rhombus.community/api-reference/face-recognition-person-webservice/delete-person.md): Delete person created for face recognition purposes.
- [Find people by organization](https://api-docs.rhombus.community/api-reference/face-recognition-person-webservice/find-people-by-organization.md): Find people created for face recognition purposes in an organization.
- [Find all person labels for organization](https://api-docs.rhombus.community/api-reference/face-recognition-person-webservice/find-all-person-labels-for-organization.md): Find all person labels for organization.
- [Get a person](https://api-docs.rhombus.community/api-reference/face-recognition-person-webservice/get-a-person.md): Get a person created for face recognition purposes.
- [Remove a label from a person](https://api-docs.rhombus.community/api-reference/face-recognition-person-webservice/remove-a-label-from-a-person.md): Remove a label from a person.
- [Update person](https://api-docs.rhombus.community/api-reference/face-recognition-person-webservice/update-person.md): Update person created for face recognition purposes.

### Feature Webservice

- [Get possible event types for specified device](https://api-docs.rhombus.community/api-reference/feature-webservice/get-possible-event-types-for-specified-device.md): Get possible event types for specified device dependent on features enabled
- [Get enabled features for a device](https://api-docs.rhombus.community/api-reference/feature-webservice/get-enabled-features-for-a-device.md): Get enabled features for a device
- [Get enabled features for all devices in an org](https://api-docs.rhombus.community/api-reference/feature-webservice/get-enabled-features-for-all-devices-in-an-org.md): Get enabled features for all devices in an org
- [Get feature compatibility matrix](https://api-docs.rhombus.community/api-reference/feature-webservice/get-feature-compatibility-matrix.md): Get feature compatability matrix
- [Update enabled features for a device](https://api-docs.rhombus.community/api-reference/feature-webservice/update-enabled-features-for-a-device.md): Update enabled features for a device

### Help Webservice

- [Leave feedback of our system](https://api-docs.rhombus.community/api-reference/help-webservice/leave-feedback-of-our-system.md): Leave feedback of our system
- [Get open support tickets for a client organization](https://api-docs.rhombus.community/api-reference/help-webservice/get-open-support-tickets-for-a-client-organization.md): Get Open Support Tickets For A Client Organization. Tickets are associated to an organziation based on the requester's organization association. This endpoint returns a paginated response sorted by the request date. The first page is indexed at 1 and each page has up to 100 ticket entries.
- [Get open support tickets for a client organization V2](https://api-docs.rhombus.community/api-reference/help-webservice/get-open-support-tickets-for-a-client-organization-v2.md): Get Open Support Tickets For A Client Organization. Tickets are associated to an organziation based on the requester's organization association.
- [Open an RMA for a camera](https://api-docs.rhombus.community/api-reference/help-webservice/open-an-rma-for-a-camera.md): Open an RMA for a camera
- [Open a support ticket](https://api-docs.rhombus.community/api-reference/help-webservice/open-a-support-ticket.md): Open a support ticket
- [Open a support ticket with file upload](https://api-docs.rhombus.community/api-reference/help-webservice/open-a-support-ticket-with-file-upload.md): Open a support ticket and optionally include a file upload. Uploading multiple Files are not supported throught this call.
- [Triage a device connection/recording issue](https://api-docs.rhombus.community/api-reference/help-webservice/triage-a-device-connectionrecording-issue.md): Triage a device connection/recording issue

### IoT Integrations Webservice

- [Delete Halo Integration](https://api-docs.rhombus.community/api-reference/iot-integrations-webservice/delete-halo-integration.md): Delete Halo Smart Sensor integration
- [Delete Intuiface Integration](https://api-docs.rhombus.community/api-reference/iot-integrations-webservice/delete-intuiface-integration.md): Delete Intuiface integration
- [Delete Omnialert Integration](https://api-docs.rhombus.community/api-reference/iot-integrations-webservice/delete-omnialert-integration.md): Delete Omnialert integration
- [Delete Shelly Integration](https://api-docs.rhombus.community/api-reference/iot-integrations-webservice/delete-shelly-integration.md): Delete Shelly integration
- [Delete Triton Integration](https://api-docs.rhombus.community/api-reference/iot-integrations-webservice/delete-triton-integration.md): Delete Triton audio sensor integration
- [Get Omnialert Integration](https://api-docs.rhombus.community/api-reference/iot-integrations-webservice/get-omnialert-integration.md): Get Omnialert integration
- [Get Shelly Integration](https://api-docs.rhombus.community/api-reference/iot-integrations-webservice/get-shelly-integration.md): Get Shelly integration
- [Update Halo Integration](https://api-docs.rhombus.community/api-reference/iot-integrations-webservice/update-halo-integration.md): Update Halo Smart Sensor integration
- [Update Intuiface Integration](https://api-docs.rhombus.community/api-reference/iot-integrations-webservice/update-intuiface-integration.md): Update Intuiface integration
- [Update Omnialert Integration](https://api-docs.rhombus.community/api-reference/iot-integrations-webservice/update-omnialert-integration.md): Update Omnialert integration
- [Update Shelly Integration](https://api-docs.rhombus.community/api-reference/iot-integrations-webservice/update-shelly-integration.md): Update Shelly rules engine integration
- [Update Triton Integration](https://api-docs.rhombus.community/api-reference/iot-integrations-webservice/update-triton-integration.md): Update Triton audio sensor integration

### Integrations Webservice

- [Delete AMT Integration](https://api-docs.rhombus.community/api-reference/integrations-webservice/delete-amt-integration.md): Delete Amt badge integration
- [Delete Device Integration](https://api-docs.rhombus.community/api-reference/integrations-webservice/delete-device-integration.md): Delete Device integration
- [Delete Mattermost Integration](https://api-docs.rhombus.community/api-reference/integrations-webservice/delete-mattermost-integration.md): Delete Mattermost alert integration
- [Delete OpenAI Integration](https://api-docs.rhombus.community/api-reference/integrations-webservice/delete-openai-integration.md): Delete OpenAI integration
- [Delete Webhook Integration](https://api-docs.rhombus.community/api-reference/integrations-webservice/delete-webhook-integration.md): Delete outbound webhook alert integration
- [Delete Webhook Integration V2](https://api-docs.rhombus.community/api-reference/integrations-webservice/delete-webhook-integration-v2.md): Delete entire webhook integration
- [Get AMT Readers](https://api-docs.rhombus.community/api-reference/integrations-webservice/get-amt-readers.md): Get list of AMT readers to assign cameras
- [Get API Token Applications](https://api-docs.rhombus.community/api-reference/integrations-webservice/get-api-token-applications.md): Get details of all open api token requests for organization
- [Get API Tokens](https://api-docs.rhombus.community/api-reference/integrations-webservice/get-api-tokens.md): Get list of all api tokens for organization
- [Get Calendly Event Details](https://api-docs.rhombus.community/api-reference/integrations-webservice/get-calendly-event-details.md): Get Calendly event details
- [Get Device Integration](https://api-docs.rhombus.community/api-reference/integrations-webservice/get-device-integration.md): Get Device integration
- [Get OpenAI Integration](https://api-docs.rhombus.community/api-reference/integrations-webservice/get-openai-integration.md): Get OpenAI integration
- [Get OpenAI Models](https://api-docs.rhombus.community/api-reference/integrations-webservice/get-openai-models.md): Get list of OpenAI models
- [Get Organization Integrations](https://api-docs.rhombus.community/api-reference/integrations-webservice/get-organization-integrations.md): Get details of all third-party integrations for organization
- [Get Organization Integrations V2](https://api-docs.rhombus.community/api-reference/integrations-webservice/get-organization-integrations-v2.md): Get details of all V2 third-party integrations for an organization
- [Get Webhook Integration](https://api-docs.rhombus.community/api-reference/integrations-webservice/get-webhook-integration.md): Get webhook integration
- [Revoke API Token](https://api-docs.rhombus.community/api-reference/integrations-webservice/revoke-api-token.md): Remove an api token from organization. Note: this is irreversible
- [Submit API Token Application](https://api-docs.rhombus.community/api-reference/integrations-webservice/submit-api-token-application.md): Request an api token for organization
- [Subscribe Zapier Webhook](https://api-docs.rhombus.community/api-reference/integrations-webservice/subscribe-zapier-webhook.md): Setup a Zapier webhook
- [Unsubscribe Zapier Webhook](https://api-docs.rhombus.community/api-reference/integrations-webservice/unsubscribe-zapier-webhook.md): Delete a Zapier webhook
- [Update AMT Integration](https://api-docs.rhombus.community/api-reference/integrations-webservice/update-amt-integration.md): Update Amt badge integration
- [Update Device Integration](https://api-docs.rhombus.community/api-reference/integrations-webservice/update-device-integration.md): Update Device integration
- [Update Mattermost Integration](https://api-docs.rhombus.community/api-reference/integrations-webservice/update-mattermost-integration.md): Update Mattermost alert integration
- [Update Noonlight Settings](https://api-docs.rhombus.community/api-reference/integrations-webservice/update-noonlight-settings.md): Update Noonlight integration
- [Update OpenAI Integration](https://api-docs.rhombus.community/api-reference/integrations-webservice/update-openai-integration.md): Update OpenAI integration
- [Update Webhook Integration](https://api-docs.rhombus.community/api-reference/integrations-webservice/update-webhook-integration.md): Update outbound webhook alert integration
- [Update Webhook Integration V2](https://api-docs.rhombus.community/api-reference/integrations-webservice/update-webhook-integration-v2.md): Update preexisting webhooks
- [Validate API Token](https://api-docs.rhombus.community/api-reference/integrations-webservice/validate-api-token.md): Verifies an API token is still active
- [Get Envoy deliveries](https://api-docs.rhombus.community/api-reference/integrations-webservice/get-envoy-deliveries.md): Get a list of deliveries from Envoy to populate reporting logs
- [Get Envoy employees](https://api-docs.rhombus.community/api-reference/integrations-webservice/get-envoy-employees.md): Get a list of employees from Envoy
- [Get Envoy locations](https://api-docs.rhombus.community/api-reference/integrations-webservice/get-envoy-locations.md): Get list of Envoy locations
- [Get Envoy visitors](https://api-docs.rhombus.community/api-reference/integrations-webservice/get-envoy-visitors.md): Get a list of visitors from Envoy to populate reporting logs

### Org Integrations Webservice

- [Get API tokens](https://api-docs.rhombus.community/api-reference/org-integrations-webservice/get-api-tokens.md): Get list of all api tokens for organization
- [Get organization integrations](https://api-docs.rhombus.community/api-reference/org-integrations-webservice/get-organization-integrations.md): Get details of all third-party integrations for organization
- [Get organization integrations V2](https://api-docs.rhombus.community/api-reference/org-integrations-webservice/get-organization-integrations-v2.md): Get details of all V2 third-party integrations for an organization
- [Revoke API token](https://api-docs.rhombus.community/api-reference/org-integrations-webservice/revoke-api-token.md): Remove an api token from organization. Note: this is irreversible

### Service Management Integrations Webservice

- [Create Envoy invite](https://api-docs.rhombus.community/api-reference/service-management-integrations-webservice/create-envoy-invite.md): Create an invite with Envoy
- [Delete Envoy integration](https://api-docs.rhombus.community/api-reference/service-management-integrations-webservice/delete-envoy-integration.md): Delete Envoy badge integration
- [Delete Envoy integration V2](https://api-docs.rhombus.community/api-reference/service-management-integrations-webservice/delete-envoy-integration-v2.md): Delete Envoy integration
- [Delete Toast integration](https://api-docs.rhombus.community/api-reference/service-management-integrations-webservice/delete-toast-integration.md): Delete Toast integration
- [Delete Toast integration V2](https://api-docs.rhombus.community/api-reference/service-management-integrations-webservice/delete-toast-integration-v2.md): Delete Toast integration
- [Get Calendly event details](https://api-docs.rhombus.community/api-reference/service-management-integrations-webservice/get-calendly-event-details.md): Get Calendly event details
- [Get Envoy integration](https://api-docs.rhombus.community/api-reference/service-management-integrations-webservice/get-envoy-integration.md): Get Envoy integration
- [Get Toast integration](https://api-docs.rhombus.community/api-reference/service-management-integrations-webservice/get-toast-integration.md): Get Toast integration
- [Get Toast service areas](https://api-docs.rhombus.community/api-reference/service-management-integrations-webservice/get-toast-service-areas.md): Get list of Toast service areas to assign cameras
- [Initiate Envoy OAuth](https://api-docs.rhombus.community/api-reference/service-management-integrations-webservice/initiate-envoy-oauth.md): Initiate the Envoy OAuth Process
- [Update Envoy integration](https://api-docs.rhombus.community/api-reference/service-management-integrations-webservice/update-envoy-integration.md): Update Envoy badge integration
- [Update Envoy integration V2](https://api-docs.rhombus.community/api-reference/service-management-integrations-webservice/update-envoy-integration-v2.md): Update Envoy integration
- [Update Toast integration](https://api-docs.rhombus.community/api-reference/service-management-integrations-webservice/update-toast-integration.md): Update Toast integration
- [Update Toast integration V2](https://api-docs.rhombus.community/api-reference/service-management-integrations-webservice/update-toast-integration-v2.md): Update Toast integration

### Storage Integrations Webservice

- [Delete AWS integration](https://api-docs.rhombus.community/api-reference/storage-integrations-webservice/delete-aws-integration.md): Delete AWS S3 clip storage integration
- [Delete Box integration](https://api-docs.rhombus.community/api-reference/storage-integrations-webservice/delete-box-integration.md): Delete Box clip storage integration
- [Delete Dropbox integration](https://api-docs.rhombus.community/api-reference/storage-integrations-webservice/delete-dropbox-integration.md): Delete Dropbox clip storage integration
- [Delete Google integration](https://api-docs.rhombus.community/api-reference/storage-integrations-webservice/delete-google-integration.md): Delete Google Drive clip storage integration
- [Delete Google integration V2](https://api-docs.rhombus.community/api-reference/storage-integrations-webservice/delete-google-integration-v2.md): Delete Google Drive clip storage integration
- [Delete Office365 integration](https://api-docs.rhombus.community/api-reference/storage-integrations-webservice/delete-office365-integration.md): Delete Office365 Sharepoint clip storage integration
- [Get Google integration](https://api-docs.rhombus.community/api-reference/storage-integrations-webservice/get-google-integration.md): Get Google Drive clip storage integration
- [Initiate Dropbox OAuth](https://api-docs.rhombus.community/api-reference/storage-integrations-webservice/initiate-dropbox-oauth.md): Initiate the Dropbox OAuth Process
- [Initiate Google OAuth](https://api-docs.rhombus.community/api-reference/storage-integrations-webservice/initiate-google-oauth.md): Initiate the Google OAuth Process
- [Initiate Office365 OAuth](https://api-docs.rhombus.community/api-reference/storage-integrations-webservice/initiate-office365-oauth.md): Initiate the Office365 OAuth Process
- [Refresh Google access token](https://api-docs.rhombus.community/api-reference/storage-integrations-webservice/refresh-google-access-token.md): Refresh Google access token
- [Revoke Google Drive access](https://api-docs.rhombus.community/api-reference/storage-integrations-webservice/revoke-google-drive-access.md): Revokes access to a Google Drive account
- [Update AWS integration](https://api-docs.rhombus.community/api-reference/storage-integrations-webservice/update-aws-integration.md): Update AWS S3 clip storage integration
- [Update Box integration](https://api-docs.rhombus.community/api-reference/storage-integrations-webservice/update-box-integration.md): Update Box clip storage integration
- [Update Dropbox integration](https://api-docs.rhombus.community/api-reference/storage-integrations-webservice/update-dropbox-integration.md): Update Dropbox clip storage integration
- [Update Google integration](https://api-docs.rhombus.community/api-reference/storage-integrations-webservice/update-google-integration.md): Update Google Drive clip storage integration
- [Update Google integration V2](https://api-docs.rhombus.community/api-reference/storage-integrations-webservice/update-google-integration-v2.md): Update Google Drive clip storage integration
- [Update Office365 integration](https://api-docs.rhombus.community/api-reference/storage-integrations-webservice/update-office365-integration.md): Update Office365 Sharepoint clip storage integration

### Webhook Integrations Webservice

- [Delete webhook integration](https://api-docs.rhombus.community/api-reference/webhook-integrations-webservice/delete-webhook-integration.md): Delete outbound webhook alert integration
- [Delete webhook integration V2](https://api-docs.rhombus.community/api-reference/webhook-integrations-webservice/delete-webhook-integration-v2.md): Delete entire webhook integration
- [Get webhook integration](https://api-docs.rhombus.community/api-reference/webhook-integrations-webservice/get-webhook-integration.md): Get webhook integration
- [Subscribe Zapier webhook](https://api-docs.rhombus.community/api-reference/webhook-integrations-webservice/subscribe-zapier-webhook.md): Setup a Zapier webhook
- [Unsubscribe Zapier webhook](https://api-docs.rhombus.community/api-reference/webhook-integrations-webservice/unsubscribe-zapier-webhook.md): Delete a Zapier webhook
- [Update webhook integration](https://api-docs.rhombus.community/api-reference/webhook-integrations-webservice/update-webhook-integration.md): Update outbound webhook alert integration
- [Update webhook integration V2](https://api-docs.rhombus.community/api-reference/webhook-integrations-webservice/update-webhook-integration-v2.md): Update preexisting webhooks

### Internal Webservice

- [Send shipment shipped email](https://api-docs.rhombus.community/api-reference/internal-webservice/send-shipment-shipped-email.md): Send shipment shipped email notification

### Alarm Monitoring Keypad Webservice

- [Claim keypad activation token](https://api-docs.rhombus.community/api-reference/alarm-monitoring-keypad-webservice/claim-keypad-activation-token.md): Connects a keypad to Rhombus services
- [Get keypads for location](https://api-docs.rhombus.community/api-reference/alarm-monitoring-keypad-webservice/get-keypads-for-location.md): Get a list of all registered keypads for a location
- [Get keypads for organization](https://api-docs.rhombus.community/api-reference/alarm-monitoring-keypad-webservice/get-keypads-for-organization.md): Get a list of all registered keypads for an org
- [Unregister keypad](https://api-docs.rhombus.community/api-reference/alarm-monitoring-keypad-webservice/unregister-keypad.md): Unregister a keypad
- [Update keypad](https://api-docs.rhombus.community/api-reference/alarm-monitoring-keypad-webservice/update-keypad.md): Update keypad settings

### Guest Management Kiosk Webservice

- [Update kiosk](https://api-docs.rhombus.community/api-reference/guest-management-kiosk-webservice/update-kiosk.md): Update kiosk settings

### License Webservice

- [Assign ACU door license](https://api-docs.rhombus.community/api-reference/license-webservice/assign-acu-door-license.md): Assign ACU door license
- [Assign alert monitoring license](https://api-docs.rhombus.community/api-reference/license-webservice/assign-alert-monitoring-license.md): Assign alert monitoring license
- [Assign device license](https://api-docs.rhombus.community/api-reference/license-webservice/assign-device-license.md): Assign or unassign a device license.
- [Assign guest management license](https://api-docs.rhombus.community/api-reference/license-webservice/assign-guest-management-license.md): Assign guest management license
- [Assign license](https://api-docs.rhombus.community/api-reference/license-webservice/assign-license.md): Assign an add-on license to a device
- [Find assigned licenses by location](https://api-docs.rhombus.community/api-reference/license-webservice/find-assigned-licenses-by-location.md): Find all licenses assigned to a location
- [Get ACU door licenses](https://api-docs.rhombus.community/api-reference/license-webservice/get-acu-door-licenses.md): Get list of access controlled door licenses licenses available in organization
- [Get ACU door licenses for client org](https://api-docs.rhombus.community/api-reference/license-webservice/get-acu-door-licenses-for-client-org.md): Get list of access controlled door licenses licenses available for a client organization
- [Get alert monitoring licenses](https://api-docs.rhombus.community/api-reference/license-webservice/get-alert-monitoring-licenses.md): Get list of alert monitoring licenses available in organization
- [Get alert monitoring licenses for client org](https://api-docs.rhombus.community/api-reference/license-webservice/get-alert-monitoring-licenses-for-client-org.md): Get list of alert monitoring licenses available for a client organization
- [Get device licenses](https://api-docs.rhombus.community/api-reference/license-webservice/get-device-licenses.md): Get list of device licenses available in organization
- [Get device licenses for client org](https://api-docs.rhombus.community/api-reference/license-webservice/get-device-licenses-for-client-org.md): Get list of device licenses available for a client organization
- [Get guest management licenses](https://api-docs.rhombus.community/api-reference/license-webservice/get-guest-management-licenses.md): Get list of guest management licenses available in organization
- [Get guest management licenses for client org](https://api-docs.rhombus.community/api-reference/license-webservice/get-guest-management-licenses-for-client-org.md): Get list of guest management licenses available for a client organization
- [Get licenses](https://api-docs.rhombus.community/api-reference/license-webservice/get-licenses.md): Get list of add-on licenses available in organization
- [Get licenses for client org](https://api-docs.rhombus.community/api-reference/license-webservice/get-licenses-for-client-org.md): Get a list of licenses available for a client organization

### ClaimKey Webservice

- [Find claim keys by client org](https://api-docs.rhombus.community/api-reference/claimkey-webservice/find-claim-keys-by-client-org.md): Find the claim keys claimed by the specified client organization, optionally filtered by state. The caller must be a partner with license administration access to the client organization. Each claim key carries the term of one purchase: `startDate` and `endDate` are the term boundaries and `gracePer…
- [Find claim keys by org](https://api-docs.rhombus.community/api-reference/claimkey-webservice/find-claim-keys-by-org.md): Find the claim keys belonging to the authenticated organization, optionally filtered by state. Each claim key carries the term of one purchase, so this is how license term start/end dates are read programmatically. See `getClaimKey` for how to read the term fields. When filtering by state, note that…
- [Get claim key](https://api-docs.rhombus.community/api-reference/claimkey-webservice/get-claim-key.md): Get the claim key with the specified uuid. A claim key represents one purchased term: `startDate` and `endDate` are the term boundaries and `gracePeriodEndDate` is 30 days past `endDate`. Note that `claimStartDate` and `claimEndDate` are when the key was redeemed, not term boundaries, and that only…

### Location Webservice

- [Add location label](https://api-docs.rhombus.community/api-reference/location-webservice/add-location-label.md): Add a label to a location
- [Create location](https://api-docs.rhombus.community/api-reference/location-webservice/create-location.md): Create a location
- [Delete location](https://api-docs.rhombus.community/api-reference/location-webservice/delete-location.md): Remove a location
- [Geocode address](https://api-docs.rhombus.community/api-reference/location-webservice/geocode-address.md): Get the latitude and longitude of an address
- [Get location](https://api-docs.rhombus.community/api-reference/location-webservice/get-location.md): Get location by id
- [Get location labels for org](https://api-docs.rhombus.community/api-reference/location-webservice/get-location-labels-for-org.md): Get all location labels for an organization
- [Get locations](https://api-docs.rhombus.community/api-reference/location-webservice/get-locations.md): Get list of locations in organization
- [Get locations by labels](https://api-docs.rhombus.community/api-reference/location-webservice/get-locations-by-labels.md): Get all locations associated to location labels for an organization
- [Get locations by geo](https://api-docs.rhombus.community/api-reference/location-webservice/get-locations-by-geo.md): Get list of locations given latitude and longitude
- [Get locations by hierarchy key](https://api-docs.rhombus.community/api-reference/location-webservice/get-locations-by-hierarchy-key.md): Get nested locations by subLocationHierarchyKey
- [Remove location label](https://api-docs.rhombus.community/api-reference/location-webservice/remove-location-label.md): Remove a label from a location
- [Selective update location](https://api-docs.rhombus.community/api-reference/location-webservice/selective-update-location.md): Selectively update a location
- [Update location](https://api-docs.rhombus.community/api-reference/location-webservice/update-location.md): Update a location **NOTE: This will replace old settings meaning if you leave a field blank it will be overrode to blank. For selective field updates use the endpoint /selectiveUpdateLocation

### Logistics Webservice

- [Get device uuids for active RMAs](https://api-docs.rhombus.community/api-reference/logistics-webservice/get-device-uuids-for-active-rmas.md): Get device uuids for active RMAs
- [Get RMAs](https://api-docs.rhombus.community/api-reference/logistics-webservice/get-rmas.md): Get RMAs
- [Get shipments](https://api-docs.rhombus.community/api-reference/logistics-webservice/get-shipments.md): Get shipments
- [Get warranty approved RMAs](https://api-docs.rhombus.community/api-reference/logistics-webservice/get-warranty-approved-rmas.md): Get warranty approved RMAs

### Media Device Webservice

- [Get bulk media device details](https://api-docs.rhombus.community/api-reference/media-device-webservice/get-bulk-media-device-details.md): Get media information of any video-supporting media device

### OAuth Webservice

- [Authorize OAuth application](https://api-docs.rhombus.community/api-reference/oauth-webservice/authorize-oauth-application.md): User authorizes to share permission and ac settings, receives temporary authorization code
- [Delete OAuth application](https://api-docs.rhombus.community/api-reference/oauth-webservice/delete-oauth-application.md): Delete application
- [Get all applications for organization](https://api-docs.rhombus.community/api-reference/oauth-webservice/get-all-applications-for-organization.md): Get all applications for org
- [Get application by client ID](https://api-docs.rhombus.community/api-reference/oauth-webservice/get-application-by-client-id.md): Get application by clientId
- [Submit OAuth application](https://api-docs.rhombus.community/api-reference/oauth-webservice/submit-oauth-application.md): Application for client_id and client_secret
- [Update OAuth application](https://api-docs.rhombus.community/api-reference/oauth-webservice/update-oauth-application.md): Update application

### Occupancy Webservice

- [Get minimal occupancy sensor state list](https://api-docs.rhombus.community/api-reference/occupancy-webservice/get-minimal-occupancy-sensor-state-list.md): Get basic state information about all proximity tags in organization
- [Get occupancy events for sensor](https://api-docs.rhombus.community/api-reference/occupancy-webservice/get-occupancy-events-for-sensor.md): Get recent events for specified proximity tag
- [Get occupancy presence windows](https://api-docs.rhombus.community/api-reference/occupancy-webservice/get-occupancy-presence-windows.md): Get stored video information for sensor
- [Update occupancy sensor details](https://api-docs.rhombus.community/api-reference/occupancy-webservice/update-occupancy-sensor-details.md): Update the details of an occupancy sensor

### Partner Webservice

- [Create partner client](https://api-docs.rhombus.community/api-reference/partner-webservice/create-partner-client.md): Create a client account
- [Customize client](https://api-docs.rhombus.community/api-reference/partner-webservice/customize-client.md): Customize a client account
- [Customize client device](https://api-docs.rhombus.community/api-reference/partner-webservice/customize-client-device.md): Customize a client device
- [Delete partner client](https://api-docs.rhombus.community/api-reference/partner-webservice/delete-partner-client.md): Delete a client account
- [Get API token applications](https://api-docs.rhombus.community/api-reference/partner-webservice/get-api-token-applications.md): Get details of all open api token requests for organization
- [Get API tokens](https://api-docs.rhombus.community/api-reference/partner-webservice/get-api-tokens.md): Get list of all api tokens for a partner
- [Get claim keys for partner organization](https://api-docs.rhombus.community/api-reference/partner-webservice/get-claim-keys-for-partner-organization.md): Get the claim keys associated with the authenticated partner organization
- [Get client devices](https://api-docs.rhombus.community/api-reference/partner-webservice/get-client-devices.md): Retrieve a list of devices for a specific client.
- [Get client status map](https://api-docs.rhombus.community/api-reference/partner-webservice/get-client-status-map.md): Get a map of all client accounts to device and location info
- [Get client summary info](https://api-docs.rhombus.community/api-reference/partner-webservice/get-client-summary-info.md): Get information about a client
- [Get partner clients](https://api-docs.rhombus.community/api-reference/partner-webservice/get-partner-clients.md): Get a list of all client accounts
- [Get partner clients V2](https://api-docs.rhombus.community/api-reference/partner-webservice/get-partner-clients-v2.md): Get a list of all client accounts. NOTICE: This is the same as getPartnerClients, but only returns the basic info so partners can login to clients quickly. The other info will be returned by getPartnerClientsStatusMap.
- [Get device licenses for organization](https://api-docs.rhombus.community/api-reference/partner-webservice/get-device-licenses-for-organization.md): Get a list of licenses available for a client organization
- [Get licenses for organization](https://api-docs.rhombus.community/api-reference/partner-webservice/get-licenses-for-organization.md): Get a list of licenses available for a client organization
- [Get list of all client devices](https://api-docs.rhombus.community/api-reference/partner-webservice/get-list-of-all-client-devices.md): Retrieve list of all devices registered across all clients
- [Get list of available hardware](https://api-docs.rhombus.community/api-reference/partner-webservice/get-list-of-available-hardware.md): Retrieve a list of hardware available for remote registration. Any hardware originally registered by a Partner is available for re-registration after being removed from an active client account.
- [Get client shipments](https://api-docs.rhombus.community/api-reference/partner-webservice/get-client-shipments.md): Get client shipments
- [Reassign device organization](https://api-docs.rhombus.community/api-reference/partner-webservice/reassign-device-organization.md): Reassign device(s) to a different organization. Only devices which hardware is controlled by the partner can be reassigned
- [Register camera to client](https://api-docs.rhombus.community/api-reference/partner-webservice/register-camera-to-client.md): Register a controlled camera to a client
- [Register deal](https://api-docs.rhombus.community/api-reference/partner-webservice/register-deal.md): Register a deal
- [Revoke API token](https://api-docs.rhombus.community/api-reference/partner-webservice/revoke-api-token.md): Remove an api token from organization. Note: this is irreversible
- [Update send license expiration email](https://api-docs.rhombus.community/api-reference/partner-webservice/update-send-license-expiration-email.md): Update send license expiration email feature flag by org

### Permission Webservice

- [Create partner permission group](https://api-docs.rhombus.community/api-reference/permission-webservice/create-partner-permission-group.md): Create a permission group
- [Create permission group](https://api-docs.rhombus.community/api-reference/permission-webservice/create-permission-group.md): Create a permission group
- [Delete partner permission group](https://api-docs.rhombus.community/api-reference/permission-webservice/delete-partner-permission-group.md): Delete a permission group
- [Delete permission group](https://api-docs.rhombus.community/api-reference/permission-webservice/delete-permission-group.md): Delete a permission group
- [Get partner permission groups](https://api-docs.rhombus.community/api-reference/permission-webservice/get-partner-permission-groups.md): Get partner permission groups for the organization
- [Get permission groups](https://api-docs.rhombus.community/api-reference/permission-webservice/get-permission-groups.md): Get details about all permission groups in organization
- [Get permissions for current partner](https://api-docs.rhombus.community/api-reference/permission-webservice/get-permissions-for-current-partner.md): Get permissions for the current partner user
- [Get permissions for current user](https://api-docs.rhombus.community/api-reference/permission-webservice/get-permissions-for-current-user.md): Get device and functionality permissions for user or API token
- [Update partner permission group](https://api-docs.rhombus.community/api-reference/permission-webservice/update-partner-permission-group.md): Update a partner permission group
- [Update permission group](https://api-docs.rhombus.community/api-reference/permission-webservice/update-permission-group.md): Update a permission group

### Proximity Webservice

- [Get locomotion events for tag](https://api-docs.rhombus.community/api-reference/proximity-webservice/get-locomotion-events-for-tag.md): Get locomotion events for specified proximity tag
- [Get minimal proximity state list](https://api-docs.rhombus.community/api-reference/proximity-webservice/get-minimal-proximity-state-list.md): Get basic state information about all proximity tags in organization
- [Get proximity events for tag](https://api-docs.rhombus.community/api-reference/proximity-webservice/get-proximity-events-for-tag.md): Get recent events for specified proximity tag
- [Update proximity sensor details](https://api-docs.rhombus.community/api-reference/proximity-webservice/update-proximity-sensor-details.md): Update details for a proximity tag

### RapidSOS Webservice

- [Get nearby feeds](https://api-docs.rhombus.community/api-reference/rapidsos-webservice/get-nearby-feeds.md): Get closest 10 feeds by lat and long

### Relay Webservice

- [Add third party camera via ONVIF](https://api-docs.rhombus.community/api-reference/relay-webservice/add-third-party-camera-via-onvif.md): Probe a single camera by IP address over ONVIF, auto-derive its metadata, and (unless disabled) provision it — adding a camera from just an IP and credentials.
- [Assign third party camera to NVR](https://api-docs.rhombus.community/api-reference/relay-webservice/assign-third-party-camera-to-nvr.md): Assign a third party camera to an NVR
- [Assign third party camera to relay camera](https://api-docs.rhombus.community/api-reference/relay-webservice/assign-third-party-camera-to-relay-camera.md): Assign a third party camera to a relay Camera
- [Assign multi-facet third party camera to NVR](https://api-docs.rhombus.community/api-reference/relay-webservice/assign-multi-facet-third-party-camera-to-nvr.md): Assign a multi-sensor third party camera to an NVR as one camera with multiple video facets (gated on the multiFacetThirdPartyCameraEnabled org flag)
- [Authenticate third party camera](https://api-docs.rhombus.community/api-reference/relay-webservice/authenticate-third-party-camera.md): Authenticate a third party camera, effectively validating the credentials specified to be used for it.
- [Create third party camera password](https://api-docs.rhombus.community/api-reference/relay-webservice/create-third-party-camera-password.md): Create a third party camera password
- [Delete third party camera discovery](https://api-docs.rhombus.community/api-reference/relay-webservice/delete-third-party-camera-discovery.md): Delete third party camera discovery if it has no assignments.
- [Delete third party camera password](https://api-docs.rhombus.community/api-reference/relay-webservice/delete-third-party-camera-password.md): Delete a third party camera password
- [Execute third party camera discovery](https://api-docs.rhombus.community/api-reference/relay-webservice/execute-third-party-camera-discovery.md): Trigger a discovery of cameras on the local LANs
- [Find discoveries with unassigned RTSP endpoints](https://api-docs.rhombus.community/api-reference/relay-webservice/find-discoveries-with-unassigned-rtsp-endpoints.md): Finds discoveries that have unassigned RTSP endpoints. Only discoveries containing at least one endpoint are returned.
- [Get assigned third party cameras](https://api-docs.rhombus.community/api-reference/relay-webservice/get-assigned-third-party-cameras.md): Get a list of the third party cameras assigned to an NVR
- [Get NVR details](https://api-docs.rhombus.community/api-reference/relay-webservice/get-nvr-details.md): Get hardware details of multiple NVRs
- [Get full NVR state](https://api-docs.rhombus.community/api-reference/relay-webservice/get-full-nvr-state.md): Get detailed information about state of specified NVR
- [Get minimal NVR state list](https://api-docs.rhombus.community/api-reference/relay-webservice/get-minimal-nvr-state-list.md): Get basic state information about all NVRs in organization
- [Get minimal third party camera state list](https://api-docs.rhombus.community/api-reference/relay-webservice/get-minimal-third-party-camera-state-list.md): Get basic state information about all third party cameras in the organization
- [Get RTSP endpoints](https://api-docs.rhombus.community/api-reference/relay-webservice/get-rtsp-endpoints.md): Gets rtsp endpoints for device with the specified mac address.
- [Get third party camera discovery scan status](https://api-docs.rhombus.community/api-reference/relay-webservice/get-third-party-camera-discovery-scan-status.md): Returns the progress of the current/most-recent third-party camera discovery run in the org, so clients can show progress and distinguish not-started, in-progress, and complete (including complete-with-zero-cameras).
- [Get third party camera passwords](https://api-docs.rhombus.community/api-reference/relay-webservice/get-third-party-camera-passwords.md): Get a list of the third party camera passwords
- [Get uptime information for an NVR.](https://api-docs.rhombus.community/api-reference/relay-webservice/get-uptime-information-for-an-nvr.md): Get uptime information for an NVR.
- [Manual discover camera](https://api-docs.rhombus.community/api-reference/relay-webservice/manual-discover-camera.md): Manually identify a camera on the network
- [PTZ move](https://api-docs.rhombus.community/api-reference/relay-webservice/ptz-move.md): Trigger a pan, tilt, or zoom
- [PTZ status](https://api-docs.rhombus.community/api-reference/relay-webservice/ptz-status.md): Returns ptz status
- [Reboot NVR](https://api-docs.rhombus.community/api-reference/relay-webservice/reboot-nvr.md): Reboot an NVR
- [Unassign third party camera](https://api-docs.rhombus.community/api-reference/relay-webservice/unassign-third-party-camera.md): Unassign a third party camera from an NVR
- [Unregister NVR](https://api-docs.rhombus.community/api-reference/relay-webservice/unregister-nvr.md): Remove an NVR from organization
- [Update NVR details V2](https://api-docs.rhombus.community/api-reference/relay-webservice/update-nvr-details-v2.md): Update hardware details of NVR.
- [Update NVR firmware](https://api-docs.rhombus.community/api-reference/relay-webservice/update-nvr-firmware.md): Send command to update firmware to NVR

### Report Webservice

- [Get audit feed](https://api-docs.rhombus.community/api-reference/report-webservice/get-audit-feed.md): Get the latest audit logs for organization
- [Get batch threshold crossing count report](https://api-docs.rhombus.community/api-reference/report-webservice/get-batch-threshold-crossing-count-report.md): Get batch threshold crossing count report
- [Get count report](https://api-docs.rhombus.community/api-reference/report-webservice/get-count-report.md): Use /getCountReportV2 instead
- [Get count report V2](https://api-docs.rhombus.community/api-reference/report-webservice/get-count-report-v2.md): Get the specified count reports
- [Get count reports](https://api-docs.rhombus.community/api-reference/report-webservice/get-count-reports.md): Get multiple specified count reports
- [Get count reports for devices at location](https://api-docs.rhombus.community/api-reference/report-webservice/get-count-reports-for-devices-at-location.md): Get count reports by device for a specified location
- [Get custom events aggregation binary counts](https://api-docs.rhombus.community/api-reference/report-webservice/get-custom-events-aggregation-binary-counts.md): Retrieves aggregated counts of boolean event values (true/false) produced by a selected prompt over a specified time window.
- [Get custom events aggregation numeric counts](https://api-docs.rhombus.community/api-reference/report-webservice/get-custom-events-aggregation-numeric-counts.md): Retrieves aggregated statistics for numeric events event values produced by a selected prompt over a specified time window. Scope & filters: 	•	promptUuid – The prompt to aggregate (required).
- [Get custom events report](https://api-docs.rhombus.community/api-reference/report-webservice/get-custom-events-report.md): Retrieves a custom events report containing raw time-series event values recorded by selected prompts and devices within the specified time window. The report can be filtered by: 	•	promptUuid – The specific prompt to query. 	•	deviceFacetUuids – A set of devices to include. 	•	locationUuid – The lo…
- [Get diagnostic feed](https://api-docs.rhombus.community/api-reference/report-webservice/get-diagnostic-feed.md): Get the latest diagnostic logs for organization
- [Get integration diagnostic events](https://api-docs.rhombus.community/api-reference/report-webservice/get-integration-diagnostic-events.md): Get the diagnostic logs of supported third-party devices for organization
- [Get license plates by device](https://api-docs.rhombus.community/api-reference/report-webservice/get-license-plates-by-device.md): Get license plate counting events for a specified camera
- [Get most recent people count events](https://api-docs.rhombus.community/api-reference/report-webservice/get-most-recent-people-count-events.md): Get the X most recent people counting events for a specified device
- [Get occupancy counts](https://api-docs.rhombus.community/api-reference/report-webservice/get-occupancy-counts.md): Returns the estimated occupancy count for a specified room or area within a given time range. This endpoint allows you to monitor occupancy trends over time or retrieve a single count for a defined interval. Important: An occupancy region must be defined in the Rhombus Console before using this endp…
- [Get occupancy counts V2](https://api-docs.rhombus.community/api-reference/report-webservice/get-occupancy-counts-v2.md): Returns the estimated occupancy count for a specified room or area within a given time range using person reidentification data. Important: An occupancy region must be defined in the Rhombus Console before using this endpoint. You can optionally specify an interval (e.g., MINUTELY, QUARTERHOURLY, HO…
- [Get proximity tag locations by date](https://api-docs.rhombus.community/api-reference/report-webservice/get-proximity-tag-locations-by-date.md): Get proximity tag locations by date
- [Get running average](https://api-docs.rhombus.community/api-reference/report-webservice/get-running-average.md): Get the running average for the specified count report if it is available, based on recent data
- [Get summary count report](https://api-docs.rhombus.community/api-reference/report-webservice/get-summary-count-report.md): Get a summary report for a camera, location, or organization
- [Get threshold crossing count report for device](https://api-docs.rhombus.community/api-reference/report-webservice/get-threshold-crossing-count-report-for-device.md): Get threshold crossing count report for device
- [Get org wide batch threshold crossing count report](https://api-docs.rhombus.community/api-reference/report-webservice/get-org-wide-batch-threshold-crossing-count-report.md): Get org wide batch threshold crossing count report
- [Get threshold crossing counts](https://api-docs.rhombus.community/api-reference/report-webservice/get-threshold-crossing-counts.md): Get the occupancy counts from threshold crossing for a group of cameras over a period of time
- [Get threshold crossing events](https://api-docs.rhombus.community/api-reference/report-webservice/get-threshold-crossing-events.md): Get the raw threshold crossing events for a group of cameras over a period of time
- [Get threshold crossing events for device](https://api-docs.rhombus.community/api-reference/report-webservice/get-threshold-crossing-events-for-device.md): Get threshold crossing events for device
- [Get Toast events table](https://api-docs.rhombus.community/api-reference/report-webservice/get-toast-events-table.md): Get list of Toast orders to populate events table
- [Get Toast events table all locations](https://api-docs.rhombus.community/api-reference/report-webservice/get-toast-events-table-all-locations.md): Get list of Toast orders from all restaurants to populate events table
- [Reset running average](https://api-docs.rhombus.community/api-reference/report-webservice/reset-running-average.md): Reset the running average for the specified count report

### Rules Webservice

- [Create rule](https://api-docs.rhombus.community/api-reference/rules-webservice/create-rule.md): Create a rule
- [Delete incoming webhook trigger token](https://api-docs.rhombus.community/api-reference/rules-webservice/delete-incoming-webhook-trigger-token.md): Delete an incoming webhook trigger token so its URL no longer fires rules
- [Delete rule](https://api-docs.rhombus.community/api-reference/rules-webservice/delete-rule.md): Delete a rule
- [Delete rule pause setting](https://api-docs.rhombus.community/api-reference/rules-webservice/delete-rule-pause-setting.md): Delete a rule pause setting
- [Generate incoming webhook trigger token](https://api-docs.rhombus.community/api-reference/rules-webservice/generate-incoming-webhook-trigger-token.md): Generate a token and public URL that fires INCOMING_WEBHOOK_EVENT rule triggers when requested
- [Get rule pause settings](https://api-docs.rhombus.community/api-reference/rules-webservice/get-rule-pause-settings.md): Get the current and planned rule pause details
- [Get rules filtered](https://api-docs.rhombus.community/api-reference/rules-webservice/get-rules-filtered.md): Get rules with Uuid and Type filtering
- [Get rules for org](https://api-docs.rhombus.community/api-reference/rules-webservice/get-rules-for-org.md): List rules for org
- [Pause rule](https://api-docs.rhombus.community/api-reference/rules-webservice/pause-rule.md): Pause rule
- [Update rule](https://api-docs.rhombus.community/api-reference/rules-webservice/update-rule.md): Update a rule

### Rules Records Webservice

- [Delete rules event record](https://api-docs.rhombus.community/api-reference/rules-records-webservice/delete-rules-event-record.md): Delete a rules event historical record
- [Get latest rules event records](https://api-docs.rhombus.community/api-reference/rules-records-webservice/get-latest-rules-event-records.md): Get N latest rules event historical records
- [Get rules event records](https://api-docs.rhombus.community/api-reference/rules-records-webservice/get-rules-event-records.md): Find rules event historical records

### Scene Query Webservice

- [Execute a prompt, ad-hoc](https://api-docs.rhombus.community/api-reference/scene-query-webservice/execute-a-prompt-ad-hoc.md): Exectue an existing prompt, ad-hoc
- [Create prompt configuration](https://api-docs.rhombus.community/api-reference/scene-query-webservice/create-prompt-configuration.md): Create scene query configuration
- [Delete prompt configuration](https://api-docs.rhombus.community/api-reference/scene-query-webservice/delete-prompt-configuration.md): Delete scene query configuration
- [Find all prompt configurations](https://api-docs.rhombus.community/api-reference/scene-query-webservice/find-all-prompt-configurations.md): Find all scene query configurations
- [Get prompt configuration](https://api-docs.rhombus.community/api-reference/scene-query-webservice/get-prompt-configuration.md): Get scene query configuration
- [Optimize prompt via chat](https://api-docs.rhombus.community/api-reference/scene-query-webservice/optimize-prompt-via-chat.md): Optimize a scene query prompt through an interactive chat with Gemini
- [Selective update prompt configuration](https://api-docs.rhombus.community/api-reference/scene-query-webservice/selective-update-prompt-configuration.md): Selectively update a scene query configuration
- [Trigger prompt](https://api-docs.rhombus.community/api-reference/scene-query-webservice/trigger-prompt.md): Trigger scene query with a custom prompt
- [Update prompt configuration](https://api-docs.rhombus.community/api-reference/scene-query-webservice/update-prompt-configuration.md): Update scene query configuration

### Schedule Webservice

- [Create absolute schedule](https://api-docs.rhombus.community/api-reference/schedule-webservice/create-absolute-schedule.md): Create a absolute schedule
- [Create relative datetime intervals schedule](https://api-docs.rhombus.community/api-reference/schedule-webservice/create-relative-datetime-intervals-schedule.md): Create a one-time relative datetime schedule
- [Create relative schedule](https://api-docs.rhombus.community/api-reference/schedule-webservice/create-relative-schedule.md): Create a realtime relative schedule
- [Create weekly schedule](https://api-docs.rhombus.community/api-reference/schedule-webservice/create-weekly-schedule.md): Create a weekly schedule
- [Delete schedule](https://api-docs.rhombus.community/api-reference/schedule-webservice/delete-schedule.md): Delete a schedule
- [Find absolute schedule](https://api-docs.rhombus.community/api-reference/schedule-webservice/find-absolute-schedule.md): Find an absolute schedule
- [Find relative datetime intervals schedule](https://api-docs.rhombus.community/api-reference/schedule-webservice/find-relative-datetime-intervals-schedule.md): Find a one-time relative datetime schedule
- [Find relative schedule](https://api-docs.rhombus.community/api-reference/schedule-webservice/find-relative-schedule.md): Find a relative schedule
- [Find weekly schedule](https://api-docs.rhombus.community/api-reference/schedule-webservice/find-weekly-schedule.md): Find a weekly schedule
- [Get schedule data](https://api-docs.rhombus.community/api-reference/schedule-webservice/get-schedule-data.md): Get weekly schedules in org with usage data
- [Get schedule data V2](https://api-docs.rhombus.community/api-reference/schedule-webservice/get-schedule-data-v2.md): Get weekly schedules in org with usage data
- [Get schedules](https://api-docs.rhombus.community/api-reference/schedule-webservice/get-schedules.md): Get schedules in org

### Search Webservice

- [Search license plates](https://api-docs.rhombus.community/api-reference/search-webservice/search-license-plates.md): Fuzzy search for license plate sightings based on a partial or full plate number. Use /vehicle/getVehicleEvents instead.
- [Search objects by color](https://api-docs.rhombus.community/api-reference/search-webservice/search-objects-by-color.md): Search for objects by color
- [Search similar object embeddings](https://api-docs.rhombus.community/api-reference/search-webservice/search-similar-object-embeddings.md): Search for similar objects by embedding
- [Search similar object embeddings by text](https://api-docs.rhombus.community/api-reference/search-webservice/search-similar-object-embeddings-by-text.md): Search for similar objects by text

### Sensor Webservice

- [Get sensor activity seekpoints for camera](https://api-docs.rhombus.community/api-reference/sensor-webservice/get-sensor-activity-seekpoints-for-camera.md): Retrieves sensor activity seekpoints for a specific camera within a given time range. Returns footage seekpoints that correspond to sensor events detected by the camera.
- [Get sensor activity seekpoints for location](https://api-docs.rhombus.community/api-reference/sensor-webservice/get-sensor-activity-seekpoints-for-location.md): Retrieves sensor activity seekpoints for a specific location within a given time range. Returns footage seekpoints that correspond to sensor events detected at the specified location.
- [Get sensor activity seekpoints for sensor](https://api-docs.rhombus.community/api-reference/sensor-webservice/get-sensor-activity-seekpoints-for-sensor.md): Retrieves sensor activity seekpoints for a specific sensor within a given time range. Returns footage seekpoints that correspond to events detected by the specified sensor device.

### TvOs Config Webservice

- [Get specific tvOs config](https://api-docs.rhombus.community/api-reference/tvos-config-webservice/get-specific-tvos-config.md): Retrieves a specific tvOs configuration by UUID, returning the detailed settings and parameters for a particular Apple TV client.
- [Get tvOs configs for organization](https://api-docs.rhombus.community/api-reference/tvos-config-webservice/get-tvos-configs-for-organization.md): Retrieves all tvOs configurations for the organization, providing a list of all Apple TV client configurations and their settings.
- [Update tvOs config](https://api-docs.rhombus.community/api-reference/tvos-config-webservice/update-tvos-config.md): Updates the configuration for a tvOs client, allowing modification of settings and parameters for Apple TV applications.

### Upload Webservice

- [Upload badge template images](https://api-docs.rhombus.community/api-reference/upload-webservice/upload-badge-template-images.md): Uploads images for badge templates with associated metadata, supporting JPEG and PNG formats with size validation and automatic S3 storage.
- [Bulk upload user profile pictures](https://api-docs.rhombus.community/api-reference/upload-webservice/bulk-upload-user-profile-pictures.md): Uploads multiple user profile pictures in a single request, supporting up to 100 photos with automatic user matching based on filename or metadata. Each photo must be <= 5MB.
- [Upload company logo](https://api-docs.rhombus.community/api-reference/upload-webservice/upload-company-logo.md): Uploads a company logo image, supporting various formats including JPEG, PNG, BMP, GIF, WebP, and PSD, and updates the organization's logo URL.
- [Upload new floorplan for location](https://api-docs.rhombus.community/api-reference/upload-webservice/upload-new-floorplan-for-location.md): Uploads a new floorplan image for a location, supporting multiple formats including JPEG, PNG, PDF, WebP, and SVG with automatic conversion to JPEG for SVG files.
- [Upload guest management document](https://api-docs.rhombus.community/api-reference/upload-webservice/upload-guest-management-document.md): Uploads a PDF or DOCX document for guest management (e.g. for e-signature via SignatureAPI), storing it in S3 and recording it on the org's guest management settings.
- [Upload keypad logo](https://api-docs.rhombus.community/api-reference/upload-webservice/upload-keypad-logo.md): Uploads a logo image for keypad devices, generating a unique UUID and storing the image with proper metadata and organization association.
- [Upload Rhombus key logo](https://api-docs.rhombus.community/api-reference/upload-webservice/upload-rhombus-key-logo.md): Uploads a logo image for Rhombus key devices, generating a unique UUID and storing the image with proper metadata and organization association.

### User Metadata Webservice

- [Create user metadata field template](https://api-docs.rhombus.community/api-reference/user-metadata-webservice/create-user-metadata-field-template.md): Create a new template user metadata field that will be applicable to all users in the organization, allowing custom field definitions for user data.
- [Delete user metadata field](https://api-docs.rhombus.community/api-reference/user-metadata-webservice/delete-user-metadata-field.md): Deletes the specified user's value stored for the specified template, removing the custom field value while preserving the template definition.
- [Delete user metadata field template](https://api-docs.rhombus.community/api-reference/user-metadata-webservice/delete-user-metadata-field-template.md): Delete a template user metadata field. THIS WILL DELETE THE CUSTOM FIELD AND USER DATA FOR THIS FIELD, permanently removing the field definition and all associated user values.
- [Find all user metadata fields in the org](https://api-docs.rhombus.community/api-reference/user-metadata-webservice/find-all-user-metadata-fields-in-the-org.md): Returns the org template metadata fields and every user's stored values for those fields, keyed by user uuid and then by template uuid. For callers that need the whole org at once, such as a user report, rather than one user at a time.
- [Find user metadata field templates](https://api-docs.rhombus.community/api-reference/user-metadata-webservice/find-user-metadata-field-templates.md): Find all template user metadata fields for the organization, returning the complete list of custom field definitions available for users.
- [Find user metadata fields](https://api-docs.rhombus.community/api-reference/user-metadata-webservice/find-user-metadata-fields.md): Returns the org template metadata fields and the queried users stored values for those fields if they've been set, providing complete metadata information for a specific user.
- [Save user metadata fields](https://api-docs.rhombus.community/api-reference/user-metadata-webservice/save-user-metadata-fields.md): Saves custom metadata values for the user specified. Template IDs that do not map to an actual org metadata template are ignored and values for omitted Template IDs are left as-is.
- [Update user metadata field template](https://api-docs.rhombus.community/api-reference/user-metadata-webservice/update-user-metadata-field-template.md): Update a template user metadata field that will be applicable to all users, allowing modification of existing custom field definitions.

### Vehicle Webservice

- [Add vehicle label](https://api-docs.rhombus.community/api-reference/vehicle-webservice/add-vehicle-label.md): Add a label to a vehicle
- [Associate events to vehicle](https://api-docs.rhombus.community/api-reference/vehicle-webservice/associate-events-to-vehicle.md): Associate vehicle events to a saved vehicle
- [Delete vehicle](https://api-docs.rhombus.community/api-reference/vehicle-webservice/delete-vehicle.md): Delete a saved vehicle
- [Get recent vehicle events](https://api-docs.rhombus.community/api-reference/vehicle-webservice/get-recent-vehicle-events.md): Get recent vehicle events for organization. Use /vehicle/getVehicleEvents instead.
- [Get recent vehicle events by location](https://api-docs.rhombus.community/api-reference/vehicle-webservice/get-recent-vehicle-events-by-location.md): Get recent vehicle events for a location. Use /vehicle/getVehicleEvents instead.
- [Get recent vehicle events for vehicle](https://api-docs.rhombus.community/api-reference/vehicle-webservice/get-recent-vehicle-events-for-vehicle.md): Get recent vehicle events for specified vehicle. Use /vehicle/getVehicleEvents instead.
- [Get vehicle events](https://api-docs.rhombus.community/api-reference/vehicle-webservice/get-vehicle-events.md): Get vehicle events with filters and additive queries
- [Get vehicle labels for organization](https://api-docs.rhombus.community/api-reference/vehicle-webservice/get-vehicle-labels-for-organization.md): Get all vehicle labels for organization
- [Get vehicles](https://api-docs.rhombus.community/api-reference/vehicle-webservice/get-vehicles.md): Get details of all saved vehicles in organization
- [Remove vehicle label](https://api-docs.rhombus.community/api-reference/vehicle-webservice/remove-vehicle-label.md): Remove a label to a vehicle
- [Report vehicle event](https://api-docs.rhombus.community/api-reference/vehicle-webservice/report-vehicle-event.md): Report a mis-detected license plate event.  This sends the image/clip to Rhombus to better train AI models and removes the event
- [Save vehicle](https://api-docs.rhombus.community/api-reference/vehicle-webservice/save-vehicle.md): Name and save a vehicle based on license plate number

### Video Webservice

- [Cancel splice](https://api-docs.rhombus.community/api-reference/video-webservice/cancel-splice.md): Use /cancelSpliceV2 instead
- [Cancel splice V2](https://api-docs.rhombus.community/api-reference/video-webservice/cancel-splice-v2.md): Cancel a spliced clip request
- [Create shared timelapse group](https://api-docs.rhombus.community/api-reference/video-webservice/create-shared-timelapse-group.md): Share multiple timelapses in one link
- [Delete shared timelapse group](https://api-docs.rhombus.community/api-reference/video-webservice/delete-shared-timelapse-group.md): Delete a shared timelapse link
- [Delete timelapse clips](https://api-docs.rhombus.community/api-reference/video-webservice/delete-timelapse-clips.md): Delete a timelapse
- [Generate ranged timelapse clip](https://api-docs.rhombus.community/api-reference/video-webservice/generate-ranged-timelapse-clip.md): Generate a timelapse where each device facet contributes footage only during its own time ranges.
- [Generate timelapse clip](https://api-docs.rhombus.community/api-reference/video-webservice/generate-timelapse-clip.md): Generate a timelapse
- [Get exact frame data](https://api-docs.rhombus.community/api-reference/video-webservice/get-exact-frame-data.md): Fetches and return bytes in base64 format of an the frame at the given timestamp for a device. Use this instead of getExactFrameUri if, for whatever reason, either the URI is not useful or the client is unable to hit the media servers
- [Get exact frame URI](https://api-docs.rhombus.community/api-reference/video-webservice/get-exact-frame-uri.md): Generate URL to get an exact frame with optional crop from a camera
- [Get max splice duration](https://api-docs.rhombus.community/api-reference/video-webservice/get-max-splice-duration.md): Get the max splice duration an organization can set
- [Get shared timelapse groups](https://api-docs.rhombus.community/api-reference/video-webservice/get-shared-timelapse-groups.md): Get details of all shared timelapse links for organization
- [Get spliced clips in progress](https://api-docs.rhombus.community/api-reference/video-webservice/get-spliced-clips-in-progress.md): Get all spliced clips in progress
- [Get timelapse clips](https://api-docs.rhombus.community/api-reference/video-webservice/get-timelapse-clips.md): Get all timelapse clips for organization
- [Get timelapse metadata](https://api-docs.rhombus.community/api-reference/video-webservice/get-timelapse-metadata.md): Get information about earliest available timelapse images for cameras
- [Retry splice](https://api-docs.rhombus.community/api-reference/video-webservice/retry-splice.md): Send a request to retry splicing a clip
- [Share timelapse clips](https://api-docs.rhombus.community/api-reference/video-webservice/share-timelapse-clips.md): Use /CreateSharedTimelapseGroup instead
- [Splice](https://api-docs.rhombus.community/api-reference/video-webservice/splice.md): Use /spliceV3 instead
- [Splice frame](https://api-docs.rhombus.community/api-reference/video-webservice/splice-frame.md): Send a request to create a single image from a point in time
- [Splice V2](https://api-docs.rhombus.community/api-reference/video-webservice/splice-v2.md): Use /spliceV3 instead
- [Splice V3](https://api-docs.rhombus.community/api-reference/video-webservice/splice-v3.md): Send a request to create an arbitrary clip for multiple cameras
- [Update shared timelapse group](https://api-docs.rhombus.community/api-reference/video-webservice/update-shared-timelapse-group.md): Update title, description, or expiration on a shared timelapse link

## OpenAPI Specs

- [public](https://api2.rhombussystems.com/api/openapi/public.json)