Get basic state information about all doorbell cameras in organization
curl --request POST \
--url https://api2.rhombussystems.com/api/doorbellcamera/getMinimalStateList \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"includeMummified": true
}
'import requests
url = "https://api2.rhombussystems.com/api/doorbellcamera/getMinimalStateList"
payload = { "includeMummified": True }
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({includeMummified: true})
};
fetch('https://api2.rhombussystems.com/api/doorbellcamera/getMinimalStateList', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/doorbellcamera/getMinimalStateList")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"includeMummified\": true\n}")
.asString();{
"minimalStates": [
{
"associatedCameras": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"connectionStatus": "RED",
"createdAtMillis": 123,
"defaultInterface": "<string>",
"defaultInterfaceMac": "<string>",
"directionRadians": 123,
"externalIPAddress": "<string>",
"facetNameMap": {},
"firmwareUpdateInProgress": true,
"firmwareVersion": "<string>",
"floorNumber": 123,
"healthStatus": "RED",
"healthStatusDetails": "DISCONNECTED",
"hwVariation": "RASPBERRY_PI_3",
"lanAddresses": [
"<string>"
],
"latitude": 123,
"liveStreamShared": true,
"liveStreamsSharedCount": 123,
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"longitude": 123,
"mediaRegion": "<string>",
"mediaStorageDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
"mummified": true,
"name": "<string>",
"policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"region": "<string>",
"secondaryLanAddresses": [
"<string>"
],
"serialNumber": "<string>",
"ssid": "<string>",
"subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
"supportedFacets": [
"v0, a0"
],
"uuid": "AAAAAAAAAAAAAAAAAAAAAA",
"wifiApMac": "<string>",
"wifiBars": 123,
"wifiSignalStrength": 123
}
]
}Doorbell Camera Webservice
Get basic state information about all doorbell cameras in organization
Get basic state information about all doorbell cameras in organization
POST
/
api
/
doorbellcamera
/
getMinimalStateList
Get basic state information about all doorbell cameras in organization
curl --request POST \
--url https://api2.rhombussystems.com/api/doorbellcamera/getMinimalStateList \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"includeMummified": true
}
'import requests
url = "https://api2.rhombussystems.com/api/doorbellcamera/getMinimalStateList"
payload = { "includeMummified": True }
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({includeMummified: true})
};
fetch('https://api2.rhombussystems.com/api/doorbellcamera/getMinimalStateList', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/doorbellcamera/getMinimalStateList")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"includeMummified\": true\n}")
.asString();{
"minimalStates": [
{
"associatedCameras": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"connectionStatus": "RED",
"createdAtMillis": 123,
"defaultInterface": "<string>",
"defaultInterfaceMac": "<string>",
"directionRadians": 123,
"externalIPAddress": "<string>",
"facetNameMap": {},
"firmwareUpdateInProgress": true,
"firmwareVersion": "<string>",
"floorNumber": 123,
"healthStatus": "RED",
"healthStatusDetails": "DISCONNECTED",
"hwVariation": "RASPBERRY_PI_3",
"lanAddresses": [
"<string>"
],
"latitude": 123,
"liveStreamShared": true,
"liveStreamsSharedCount": 123,
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"longitude": 123,
"mediaRegion": "<string>",
"mediaStorageDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA.v0",
"mummified": true,
"name": "<string>",
"policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"region": "<string>",
"secondaryLanAddresses": [
"<string>"
],
"serialNumber": "<string>",
"ssid": "<string>",
"subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
"supportedFacets": [
"v0, a0"
],
"uuid": "AAAAAAAAAAAAAAAAAAAAAA",
"wifiApMac": "<string>",
"wifiBars": 123,
"wifiSignalStrength": 123
}
]
}Authorizations
Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).
Headers
Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.
Available options:
api-token, api, partner-api-token, partner-api Body
application/json
Response
200 - application/json
OK
Response object containing basic state information for all doorbell cameras.
List of minimal state information for doorbell cameras
Show child attributes
Show child attributes
Last modified on September 18, 2026