> ## Documentation index
> Fetch the complete documentation index at: https://developer.rhombus.com/llms.txt
> Use it to discover all available pages before exploring further.

# API Reference

> Complete REST API reference covering 1,000+ Rhombus endpoints for cameras, access control, sensors, alarms, video streaming, and analytics.

The Rhombus API gives you programmatic access to the full Rhombus platform across 1,000+ endpoints. Every endpoint you see here is the same one that powers the Rhombus web console and mobile apps. If you can do it in the Rhombus UI, you can do it through the API.

## Authentication

Every request carries a credential in headers. With an API key, send `x-auth-scheme: api-token` and the key in `x-auth-apikey`; with an OAuth access token, send `Authorization: Bearer <token>`. Each operation's page lists `x-auth-scheme` and `x-auth-org`:

| Header                | When                                                                  | Value                                                                                                                                                                                                                                           |
| --------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `x-auth-scheme`       | Every request, except that it's optional with `Authorization: Bearer` | One of seven schemes: `api-token` (API key), `api` (certificate API key), `api-oauth-token` (OAuth access token), `federated-token` (federated token), and the partner aliases `partner-api-token`, `partner-api` and `partner-api-oauth-token` |
| `x-auth-apikey`       | API keys and certificate API keys                                     | Your API key from the [Rhombus Console](https://console.rhombussystems.com/settings/integrations/api-tokens/)                                                                                                                                   |
| `Authorization`       | OAuth access tokens                                                   | `Bearer <access token>`. A Bearer header with no `x-auth-scheme` is read as an OAuth access token ([Sign in with Rhombus](https://developer.rhombus.com/oauth-authentication))                                                                  |
| `x-auth-access-token` | OAuth access tokens, as an alternative to `Authorization`             | The access token, with `x-auth-scheme: api-oauth-token`                                                                                                                                                                                         |
| `x-auth-ft`           | Federated tokens                                                      | The token, with `x-auth-scheme: federated-token` ([Federated tokens](https://developer.rhombus.com/authentication/federated-tokens))                                                                                                            |
| `x-auth-org`          | Optional on every operation, for partner credentials                  | The UUID of the client organization to act in. A header only; a blank value counts as absent ([Partner API Calls](https://developer.rhombus.com/partner-api-calls))                                                                             |

```bash cURL
curl -X POST https://api2.rhombussystems.com/api/org/getOrgV2 \
  -H "x-auth-scheme: api-token" \
  -H "x-auth-apikey: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

```python Python
import requests

response = requests.post(
    "https://api2.rhombussystems.com/api/org/getOrgV2",
    headers={
        "x-auth-scheme": "api-token",
        "x-auth-apikey": "YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={},
)

print(response.json())
```

```bash cURL (OAuth)
curl -X POST https://api2.rhombussystems.com/api/org/getOrgV2 \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'
```

An OAuth access token also needs the [scope](https://developer.rhombus.com/oauth-authentication#scopes) the operation requires; each operation's page shows it. See [Authentication](https://developer.rhombus.com/authentication) for which credential to use where.

## Base URL

All API requests are made to one of two base URLs depending on the type of operation. Each has a US and an EU variant — use the one that matches your organization's [region](https://developer.rhombus.com/api-regions):

| Purpose                                                                   | US                                 | EU                                    |
| ------------------------------------------------------------------------- | ---------------------------------- | ------------------------------------- |
| All API endpoints (device management, configuration, events, users, etc.) | `https://api2.rhombussystems.com`  | `https://api2.eu.rhombussystems.com`  |
| Media and streaming operations (video clips, live streams, thumbnails)    | `https://media.rhombussystems.com` | `https://media.eu.rhombussystems.com` |

> **Info**: API keys are region-bound — a key generated in one region's console returns `401` with `errorCode` `INVALID_CREDENTIAL` against the other region's endpoints. See [API Regions (US & EU)](https://developer.rhombus.com/api-regions).

## Common patterns

- **Requests are POST with a JSON body** — almost every endpoint takes a `POST` with a JSON body, even read operations. The exceptions: OAuth authorization (`GET /api/oauth/authorize`), and file uploads such as `/api/upload/...`, which take `multipart/form-data`.
- **Responses are JSON** — except file downloads: several `/api/export/...` endpoints return CSV (`/api/export/uptime` returns a ZIP archive), and `/api/video/getLiveImage` returns a JPEG image. Each endpoint's page shows its response type.
- **Empty body for simple queries** — endpoints that do not require parameters still expect an empty JSON object (`{}`).
- **Errors share one body** — `msg`, `error` (`true`), `errorCode`, `errorMsg`, `status`, `timestamp` and `txid`, plus an `x-rhombus-txid` response header. A `401` means the credential is missing or not valid; a `403` means it's valid but not permitted. See [Errors](https://developer.rhombus.com/errors).

## Browse by category

Every operation, grouped by product. The sidebar lists them the same way.

**Cameras & Video**

- [Camera](https://developer.rhombus.com/api-reference/camera-webservice/calibrate-floorplan-projection) (61)
- [Video](https://developer.rhombus.com/api-reference/video-webservice/cancel-splice-v2) (18)
- [Doorbell Camera](https://developer.rhombus.com/api-reference/doorbell-camera-webservice/generate-the-homography-to-project-detections-onto-a-floorplan) (25)
- [Doorbell](https://developer.rhombus.com/api-reference/doorbell-webservice/get-stored-video-information-for-a-doorbell-camera) (2)
- [Relay (third-party cameras)](https://developer.rhombus.com/api-reference/relay-webservice/add-third-party-camera-via-onvif) (29)
- [Media Device](https://developer.rhombus.com/api-reference/media-device-webservice/get-bulk-media-device-details) (1)
- [Device Config](https://developer.rhombus.com/api-reference/device-config-webservice/get-a-devices-config) (2)
- [Device Label](https://developer.rhombus.com/api-reference/device-label-webservice/add-a-label-to-a-device) (3)

**Audio**

- [Audio Gateways](https://developer.rhombus.com/api-reference/audiogateway-webservice/delete-audio-gateway) (10)
- [Audio Playback](https://developer.rhombus.com/api-reference/audioplayback-webservice/cancel-looping-audio-playback) (6)

**Access Control**

- [Access Control](https://developer.rhombus.com/api-reference/access-control-webservice/add-users-to-access-control-group) (62)
- [Access Control Components](https://developer.rhombus.com/api-reference/component-webservice/create-a-label-that-can-be-assigned-to-an-access-controlled-door) (62)
- [Door](https://developer.rhombus.com/api-reference/door-webservice/get-list-of-door-openclose-events-for-door-sensor) (4)
- [Door Controller](https://developer.rhombus.com/api-reference/door-controller-webservice/register-a-rhombus-reader-that-a-door-controller-has-discovered) (2)
- [Badge Reader](https://developer.rhombus.com/api-reference/badge-reader-webservice/delete-badge-reader) (2)
- [Elevator](https://developer.rhombus.com/api-reference/elevator-webservice/create-a-label-that-can-be-assigned-to-an-access-controlled-elevator-landing) (6)
- [Lockdown Plan](https://developer.rhombus.com/api-reference/lockdown-plan-webservice/activate-lockdown-for-the-specified-location) (17)
- [Proximity](https://developer.rhombus.com/api-reference/proximity-webservice/get-locomotion-events-for-tag) (4)
- [Guest Management Kiosk](https://developer.rhombus.com/api-reference/guest-management-kiosk-webservice/update-kiosk) (1)

**Alarm Monitoring**

- [Alarm Monitoring Keypad](https://developer.rhombus.com/api-reference/alarm-monitoring-keypad-webservice/claim-keypad-activation-token) (5)
- [RapidSOS](https://developer.rhombus.com/api-reference/rapidsos-webservice/get-nearby-feeds) (1)

**Sensors & Environment**

- [Climate](https://developer.rhombus.com/api-reference/climate-webservice/delete-environmental-gateway) (12)
- [Occupancy](https://developer.rhombus.com/api-reference/occupancy-webservice/get-minimal-occupancy-sensor-state-list) (4)
- [Button](https://developer.rhombus.com/api-reference/button-webservice/create-rule-for-button) (8)
- [Sensor](https://developer.rhombus.com/api-reference/sensor-webservice/get-sensor-activity-seekpoints-for-camera) (3)
- [Bluetooth (BLE)](https://developer.rhombus.com/api-reference/ble-webservice/get-base-stations) (1)

**Events, Alerts & Rules**

- [Event](https://developer.rhombus.com/api-reference/event-webservice/share-multiple-clips-in-a-single-page) (36)
- [Policy](https://developer.rhombus.com/api-reference/policy-webservice/create-access-controlled-door-policy) (54)
- [Rules](https://developer.rhombus.com/api-reference/rules-webservice/create-rule) (12)
- [Rules Records](https://developer.rhombus.com/api-reference/rules-records-webservice/delete-rules-event-record) (3)

**Analytics & AI**

- [Report](https://developer.rhombus.com/api-reference/report-webservice/get-audit-feed) (25)
- [Export](https://developer.rhombus.com/api-reference/export-webservice/download-audit-log) (16)
- [Face Recognition Event](https://developer.rhombus.com/api-reference/face-recognition-event-webservice/delete-face-event) (11)
- [Face Recognition Person](https://developer.rhombus.com/api-reference/face-recognition-person-webservice/add-a-label-to-a-person) (8)
- [Face Recognition Matchmaker](https://developer.rhombus.com/api-reference/face-recognition-matchmaker-webservice/create-face-matchmaker-from-sighting) (11)
- [Vehicle](https://developer.rhombus.com/api-reference/vehicle-webservice/add-vehicle-label) (9)
- [Search](https://developer.rhombus.com/api-reference/search-webservice/search-objects-by-color) (3)
- [Scene Query](https://developer.rhombus.com/api-reference/scene-query-webservice/execute-a-prompt-ad-hoc) (9)

**Robots**

- [Robot](https://developer.rhombus.com/api-reference/robot-webservice/create-a-robot-patrol) (35)

**Users & Organization**

- [Organization](https://developer.rhombus.com/api-reference/org-webservice/claim-activation-token) (43)
- [Location](https://developer.rhombus.com/api-reference/location-webservice/add-location-label) (15)
- [User](https://developer.rhombus.com/api-reference/user-webservice/update-notification-settings-for-user) (11)
- [User Metadata](https://developer.rhombus.com/api-reference/user-metadata-webservice/create-user-metadata-field-template) (8)
- [Permission](https://developer.rhombus.com/api-reference/permission-webservice/create-partner-permission-group) (10)
- [License](https://developer.rhombus.com/api-reference/license-webservice/assign-acu-door-license) (21)
- [Customer](https://developer.rhombus.com/api-reference/customer-webservice/delete-all-notification-snooze-settings) (5)
- [Claim Keys](https://developer.rhombus.com/api-reference/claimkey-webservice/find-claim-keys-by-client-org) (3)

**Integrations**

- [Webhook Integrations](https://developer.rhombus.com/api-reference/webhook-integrations-webservice/delete-webhook-integration) (13)
- [Integrations](https://developer.rhombus.com/api-reference/integrations-webservice/validate-api-token) (5)
- [Org Integrations](https://developer.rhombus.com/api-reference/org-integrations-webservice/get-api-tokens) (7)
- [Access Control Integrations](https://developer.rhombus.com/api-reference/access-control-integrations-webservice/connect-honeywell-elements-validate-+-persist) (95)
- [Incident Management Integrations](https://developer.rhombus.com/api-reference/incident-management-integrations-webservice/delete-dice-integration) (35)
- [Service Management Integrations](https://developer.rhombus.com/api-reference/service-management-integrations-webservice/create-envoy-invite) (10)
- [Storage Integrations](https://developer.rhombus.com/api-reference/storage-integrations-webservice/delete-aws-integration) (16)
- [IoT Integrations](https://developer.rhombus.com/api-reference/iot-integrations-webservice/delete-halo-integration) (12)

**Partners**

- [Partner](https://developer.rhombus.com/api-reference/partner-webservice/create-partner-client) (38)

**Platform & Config**

- [Schedule](https://developer.rhombus.com/api-reference/schedule-webservice/create-absolute-schedule) (12)
- [OAuth](https://developer.rhombus.com/api-reference/oauth-webservice/authorize-oauth-application) (1)
- [Developer](https://developer.rhombus.com/api-reference/developer-webservice/create-an-event-listener) (4)
- [Upload](https://developer.rhombus.com/api-reference/upload-webservice/upload-badge-template-images) (8)
- [Feature](https://developer.rhombus.com/api-reference/feature-webservice/get-possible-event-types-for-specified-device) (5)
- [Help](https://developer.rhombus.com/api-reference/help-webservice/leave-feedback-of-our-system) (6)
- [tvOS Config](https://developer.rhombus.com/api-reference/tvos-config-webservice/get-specific-tvos-config) (3)
- [Logistics](https://developer.rhombus.com/api-reference/logistics-webservice/get-device-uuids-for-active-rmas) (4)

**Other**

- [Device Health](https://developer.rhombus.com/api-reference/device-health-webservice/disable-device-health-tracking) (4)
- [Partner Portal](https://developer.rhombus.com/api-reference/partner-portal-webservice/create-partner-portal-mdf-claim) (25)

> **Note**: This reference is generated from the production OpenAPI specification each time the site is built. Use **Try it** on any endpoint page to send a request with your API key.
