Skip to main content
POST
/
api
/
door
/
getMinimalDoorStateList
Get basic state information for all door sensors
curl --request POST \
  --url https://api2.rhombussystems.com/api/door/getMinimalDoorStateList \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '{}'
{
  "doorStates": [
    {
      "associatedCameras": [
        "AAAAAAAAAAAAAAAAAAAAAA.v0"
      ],
      "batteryPercent": 75,
      "closestBaseStation": "AAAAAAAAAAAAAAAAAAAAAA",
      "createdAtMillis": 1640995200000,
      "firmwareVersion": "1.2.3",
      "floorNumber": 1,
      "health": "GREEN",
      "healthDetails": "FIRMWARE_BEHIND",
      "hwVariation": "RASPBERRY_PI_3",
      "lastSeenSec": 1640995200,
      "latitude": 37.7749,
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "longitude": -122.4194,
      "name": "Main Entrance Door",
      "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "sensorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "serialNumber": "DS123456789",
      "signalStrength": 85,
      "status": "OPEN"
    }
  ],
  "error": true,
  "errorMsg": "<string>",
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for retrieving basic state information for all door sensors.

Response

200 - application/json

OK

Response object containing basic state information for all door sensors.

doorStates
object[] | null

List of minimal door state information for all door sensors

error
boolean | null
errorMsg
string | null
warningMsg
string | null