Get minimal button state list

Get basic state information for all button sensors

POST /api/button/getMinimalButtonStateList

Get minimal button state list

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 '{}'

200

{
  "error": true,
  "errorMsg": "<string>",
  "states": [
    {
      "associatedCameras": [
        "AAAAAAAAAAAAAAAAAAAAAA.v0"
      ],
      "batteryPercent": 85,
      "buttonEmergencyOnsiteContact": {
        "name": "<string>",
        "phoneNumber": "<string>"
      },
      "closestBaseStation": "AAAAAAAAAAAAAAAAAAAAAA",
      "createdAtMillis": 1640995200000,
      "firmwareVersion": "2.1.0",
      "floorNumber": 1,
      "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>"
}

Authorizations

x-auth-apikey · string · header · required

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

x-auth-scheme · enum<string> · default: api-token · required

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 to get minimal state information for all button sensors.

Response

200 - application/json

OK

Response containing minimal state information for all button sensors.

error · boolean | null

errorMsg · string | null

states · object[] | null

List of minimal button state information

Show child attributes

warningMsg · string | null