Skip to main content
POST
/
api
/
climate
/
getMinimalClimateStateList
Get minimal climate state list
curl --request POST \
  --url https://api2.rhombussystems.com/api/climate/getMinimalClimateStateList \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '{}'
{
  "climateStates": [
    {
      "associatedCameras": [
        "AAAAAAAAAAAAAAAAAAAAAA.v0"
      ],
      "batteryPercent": 85,
      "calibrating": false,
      "closestBaseStation": "AAAAAAAAAAAAAAAAAAAAAA",
      "co2": 450,
      "createdAtMillis": 1640995200000,
      "ethanol": 5.2,
      "firmwareVersion": "1.2.3",
      "floorNumber": 2,
      "health": "GREEN",
      "healthDetails": "FIRMWARE_BEHIND",
      "heatIndexDegF": 85.2,
      "heatIndexRangeWarning": "HEAT_INDEX_OK",
      "humidity": 45.2,
      "hwVariation": "RASPBERRY_PI_3",
      "iaq": 85.5,
      "lastSeenSec": 1640995200,
      "latitude": 37.7749,
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "longitude": -122.4194,
      "name": "Office Climate Sensor",
      "pm25": 12.3,
      "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "probeConnected": true,
      "probeTempC": 24.1,
      "sensorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "serialNumber": "ES-123456789",
      "signalStrength": 85,
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "temperatureCelcius": 23.5,
      "thcPercent": 0.8,
      "tvoc": 125.5,
      "vapePercent": 2.1
    }
  ],
  "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 to retrieve minimal climate state information for all environmental sensors.

Response

200 - application/json

OK

Response containing minimal climate state information for environmental sensors.

climateStates
object[] | null

List of minimal climate state information

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