Skip to main content

ā€‹
Quick Start

1

Get API Credentials

Generate your API key in the Rhombus Console. Choose token-based (simpler) or certificate-based (more secure) authentication.
2

Make Your First Request

Test your connection with a simple API call. All requests go to https://api2.rhombussystems.com with your API key in the headers.
3

Explore the API Reference

Browse 800+ endpoints to discover capabilities for your integration.
4

Join the Community

Get help and share experiences at rhombus.community.

ā€‹
Integration Options

OpenAPI 3.0 Specification: Download our machine-readable spec for automated client generation.
JavaScript
const response = await fetch('https://api2.rhombussystems.com/api/camera/getMinimalCameraStateList', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY'
  },
  body: JSON.stringify({})
});

const data = await response.json();
console.log(`Found ${data.cameraStates.length} cameras`);

ā€‹
What You Can Build

Camera Management

Stream live video, retrieve recordings, manage camera settings, and access metadata

Access Control

Manage doors, users, credentials, and access events across your facilities

Environmental Monitoring

Monitor temperature, humidity, air quality, and other environmental conditions

Analytics & Insights

Access AI-powered analytics, people counting and object detection

Event Management

Create custom workflows, manage notifications, and respond to security events

Device Administration

Configure devices, manage firmware updates, and monitor system health

ā€‹
Authentication & Base URL

All API requests use this base URL: 
https://api2.rhombussystems.com
Include authentication headers in every request: 
x-auth-scheme: api-token
x-auth-apikey: YOUR_API_KEY
Store your API key securely - it provides full access to your organizationā€™s data.

ā€‹
Community & Support

Developer Community

Get help from Rhombus engineers and fellow developers. Share integration examples, troubleshoot issues, and learn best practices.

Rhombus Console

Manage API keys and configure your Rhombus platform. Pro tip: Use Chrome DevTools to inspect network requests for implementation hints.
Always Up to Date: This documentation syncs nightly with our production API to ensure accuracy.