> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.rhombus.community/llms.txt
> Use this file to discover all available pages before exploring further.

# API Reference

> Complete REST API reference covering 900+ 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 900+ endpoints. Built on an API-first architecture since 2016, every endpoint you see here is the same one that powers the Rhombus web console, mobile apps, and firmware. If you can do it in the Rhombus UI, you can do it through the API.

## Authentication

Every request requires two headers for token-based authentication:

| Header          | Value                                                                                                |
| --------------- | ---------------------------------------------------------------------------------------------------- |
| `x-auth-scheme` | `api-token`                                                                                          |
| `x-auth-apikey` | Your API key from the [Rhombus Console](https://console.rhombussystems.com/settings/api-management/) |

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

  ```python Python theme={null}
  import requests

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

  print(response.json())
  ```
</CodeGroup>

## Base URL

All API requests are made to one of two base URLs depending on the type of operation:

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

## Common Patterns

* **All requests use POST** — every endpoint accepts a `POST` request with a JSON body, even for read operations.
* **All responses are JSON** — responses follow a consistent JSON structure across the entire API.
* **Empty body for simple queries** — endpoints that do not require parameters still expect an empty JSON object (`{}`).

## Browse by Category

<CardGroup cols={3}>
  <Card title="Cameras & Video" icon="camera">
    Manage cameras, retrieve clips, configure video settings, and access live and recorded footage.
  </Card>

  <Card title="Audio" icon="volume">
    Control audio devices, manage audio clips, and configure speaker settings.
  </Card>

  <Card title="Access Control" icon="door-open">
    Manage doors, access points, credentials, and entry logs.
  </Card>

  <Card title="Sensors & Environment" icon="temperature-half">
    Monitor environmental sensors, retrieve readings, and configure thresholds.
  </Card>

  <Card title="Events & Alerts" icon="bell">
    Query events, configure alert rules, and manage notification preferences.
  </Card>

  <Card title="Analytics & AI" icon="brain">
    Access face recognition, license plate detection, people counting, and other AI-powered features.
  </Card>

  <Card title="Users & Organization" icon="users">
    Manage users, roles, permissions, and organization settings.
  </Card>

  <Card title="Integrations" icon="plug">
    Configure webhooks, third-party connections, and external system integrations.
  </Card>

  <Card title="Platform & Config" icon="gear">
    System configuration, firmware management, network settings, and platform administration.
  </Card>
</CardGroup>

<Note>
  This reference is generated directly from our production OpenAPI spec, which is fetched fresh on every site build. We also check the upstream API for changes several times a day and redeploy automatically, so the reference stays current. Use the interactive playground on any endpoint page to test requests with your API key.
</Note>