🚧 The Rhombus Developer Documentation is currently in beta. For the official documentation, please visit docs.rhombus.com.
English
cURL
curl --request POST \ --url https://api2.rhombussystems.com/api/button/getMinimalButtonStateList \ --header 'Content-Type: application/json' \ --header 'x-auth-apikey: <api-key>' \ --header 'x-auth-scheme: <x-auth-scheme>' \ --data '{}'
{ "error": true, "errorMsg": "<string>", "states": [ { "associatedCameras": [ "AAAAAAAAAAAAAAAAAAAAAA.v0" ], "batteryPercent": 85, "buttonEmergencyOnsiteContact": { "name": "<string>", "phoneNumber": "<string>" }, "buttonMode": "PANIC", "closestBaseStation": "AAAAAAAAAAAAAAAAAAAAAA", "createdAtMillis": 1640995200000, "firmwareVersion": "2.1.0", "floorNumber": 1, "health": "GREEN", "healthDetails": "FIRMWARE_BEHIND", "hwVariation": "RASPBERRY_PI_3", "lastSeenSec": 1640995200, "latitude": 37.7749, "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA", "longitude": -122.4194, "name": "Main Entrance Button", "sensorUuid": "AAAAAAAAAAAAAAAAAAAAAA", "serialNumber": "SN123456789", "signalStrength": -45, "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA", "testModeEnabled": false } ], "warningMsg": "<string>" }
Get basic state information for all button sensors
Your API key for Rhombus.
Authentication scheme indicator ("api-token").
9
Request to get minimal state information for all button sensors.
OK
Response containing minimal state information for all button sensors.
List of minimal button state information
Show child attributes
Was this page helpful?