Get minimal occupancy sensor state list
curl --request POST \
--url https://api2.rhombussystems.com/api/occupancy/getMinimalOccupancySensorStateList \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '{}'import requests
url = "https://api2.rhombussystems.com/api/occupancy/getMinimalOccupancySensorStateList"
payload = {}
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({})
};
fetch('https://api2.rhombussystems.com/api/occupancy/getMinimalOccupancySensorStateList', 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/occupancy/getMinimalOccupancySensorStateList")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{}")
.asString();{
"error": true,
"errorMsg": "<string>",
"occupancySensorStates": [
{
"associatedCameras": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"batteryPercent": 85,
"closestBaseStation": "AAAAAAAAAAAAAAAAAAAAAA",
"firmwareVersion": "1.2.3",
"floorNumber": 2,
"health": "RED",
"healthDetails": "NO_HEARTBEAT",
"hwVariation": "RASPBERRY_PI_3",
"lastSeenSec": 1640995200,
"latitude": 37.7749,
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"longitude": -122.4194,
"name": "Conference Room Sensor",
"normalizedLux": 0.75,
"policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"rawLux": 500,
"sensorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"serialNumber": "RH123456789",
"signalStrength": -45,
"status": "VACANT",
"subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
}
],
"warningMsg": "<string>"
}Occupancy Webservice
Get minimal occupancy sensor state list
Get basic state information about all proximity tags in organization
POST
/
api
/
occupancy
/
getMinimalOccupancySensorStateList
Get minimal occupancy sensor state list
curl --request POST \
--url https://api2.rhombussystems.com/api/occupancy/getMinimalOccupancySensorStateList \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '{}'import requests
url = "https://api2.rhombussystems.com/api/occupancy/getMinimalOccupancySensorStateList"
payload = {}
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({})
};
fetch('https://api2.rhombussystems.com/api/occupancy/getMinimalOccupancySensorStateList', 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/occupancy/getMinimalOccupancySensorStateList")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{}")
.asString();{
"error": true,
"errorMsg": "<string>",
"occupancySensorStates": [
{
"associatedCameras": [
"AAAAAAAAAAAAAAAAAAAAAA.v0"
],
"batteryPercent": 85,
"closestBaseStation": "AAAAAAAAAAAAAAAAAAAAAA",
"firmwareVersion": "1.2.3",
"floorNumber": 2,
"health": "RED",
"healthDetails": "NO_HEARTBEAT",
"hwVariation": "RASPBERRY_PI_3",
"lastSeenSec": 1640995200,
"latitude": 37.7749,
"locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"longitude": -122.4194,
"name": "Conference Room Sensor",
"normalizedLux": 0.75,
"policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"rawLux": 500,
"sensorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"serialNumber": "RH123456789",
"signalStrength": -45,
"status": "VACANT",
"subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
}
],
"warningMsg": "<string>"
}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
Request object for getting minimal occupancy sensor states for all sensors in organization.
Last modified on October 5, 2026