Climate

Get minimal environmental gateway states

Get list of basic states of all environmental gateways of an org

POST/api/climate/getMinimalEnvironmentalGatewayStates

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

Request to retrieve minimal environmental gateway states.

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/climate/getMinimalEnvironmentalGatewayStates' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api2.rhombussystems.com/api/climate/getMinimalEnvironmentalGatewayStates"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/climate/getMinimalEnvironmentalGatewayStates', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {}
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/climate/getMinimalEnvironmentalGatewayStates"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "error": false,
  "errorCode": "<string>",
  "lastEvaluatedKey": "<string>",
  "minimalEnvironmentalGatewayStates": [
    {
      "activities": [
        "SOUND_LOUD"
      ],
      "airQualityIndex": 45,
      "airQualityIndexPollutant": "OZONE",
      "alertTriggers": [
        "SOUND_LOUD"
      ],
      "associatedCameras": [
        "AAAAAAAAAAAAAAAAAAAAAA.v0"
      ],
      "calibrating": false,
      "ch2oPpb": 15.7,
      "co2Ppm": 450,
      "coConcentration": 2.1,
      "connected": true,
      "createdAtMillis": 1640995200000,
      "defaultInterfaceMac": "00:1A:2B:3C:4D:5E",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "externalIPAddress": "203.0.113.1",
      "falsePositiveConfidencePercent": 5.2,
      "firmwareVersion": "2.1.5",
      "floorNumber": 2,
      "healthDetails": "NONE",
      "healthStatus": "GREEN",
      "heatIndexDegF": 85.2,
      "heatIndexRangeWarning": "HEAT_INDEX_OK",
      "hwVariation": "RASPBERRY_PI_3",
      "iaq": 85.5,
      "lanAddresses": [
        "<string>"
      ],
      "latitude": 37.7749,
      "leakDetected": false,
      "leakProbePresent": true,
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "longitude": -122.4194,
      "name": "Main Office Gateway",
      "nc0p5": 120.5,
      "nc10p0": 15.3,
      "nc1p0": 85.2,
      "nc2p5": 45.8,
      "nc4p0": 32.1,
      "noxIdx": 88.2,
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "pm10p0": 18.9,
      "pm1p0": 8.5,
      "pm2p5": 12.3,
      "pm4p0": 15.7,
      "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "pressure": 1013.25,
      "probeTempC": 24.5,
      "relHumid": 45.2,
      "serialNumber": "EG-123456789",
      "smokeConfidencePercent": 92.8,
      "smokeTobaccoConfidencePercent": 88.1,
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "tempC": 23.5,
      "tempProbePresent": true,
      "timestampMs": 1640995200000,
      "typPartSize": 2.8,
      "vapeConfidencePercent": 85.5,
      "vapeDetected": false,
      "vapeThcConfidencePercent": 72.3,
      "vocIdx": 125.5
    }
  ]
}

Response

200 OK

application/json · object

Response containing minimal environmental gateway states.

errorboolean | null

errorCodestring | null

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring | null

lastEvaluatedKeystring | null

minimalEnvironmentalGatewayStatesobject[] | null

List of minimal environmental gateway states

Show child attributes

activitiesenum<string>[] | null

List of detected activities

airQualityIndexinteger<int32> | null

Air quality index value

Example: 45

airQualityIndexPollutantenum<string>

Primary pollutant affecting air quality index

Available options: OZONE, PM2P5, PM10P0, CO, NO2, SO2, UNKNOWN

alertTriggersenum<string>[] | null

List of alert triggers

associatedCamerasstring<DeviceFacetUuid>[] | null

List of associated camera device facet UUIDs

calibratingboolean | null

Whether the gateway is currently calibrating

Example: false

ch2oPpbnumber<float> | null

Formaldehyde measurement in parts per billion

Example: 15.7

co2Ppminteger<int32> | null

CO2 measurement in parts per million

Example: 450

coConcentrationnumber<double> | null

Carbon monoxide concentration

Example: 2.1

connectedboolean | null

Whether the gateway is connected

Example: true

createdAtMillisinteger<int64> | null

Creation timestamp in milliseconds

Example: 1640995200000

defaultInterfaceMacstring | null

Default interface MAC address

Example: "00:1A:2B:3C:4D:5E"

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

externalIPAddressstring | null

External IP address

Example: "203.0.113.1"

falsePositiveConfidencePercentnumber<float> | null

False positive confidence percentage

Example: 5.2

firmwareVersionstring | null

Firmware version

Example: "2.1.5"

floorNumberinteger<int32> | null

Floor number

Example: 2

healthDetailsenum<string>

Available options: DISCONNECTED, FIRMWARE_BEHIND, NOT_RECORDING, LINK_SPEED_LOW, MALFUNCTIONING_MODULES, CALIBRATING, DELAYED, NONE

healthStatusenum<string>

Available options: RED, ORANGE, YELLOW, GREEN

heatIndexDegFnumber<double> | null

Heat index in degrees Fahrenheit

Example: 85.2

heatIndexRangeWarningenum<string>

Heat index range warning status

Available options: HEAT_INDEX_OK, HEAT_INDEX_WARNING, HEAT_INDEX_UNSUPPORTED

hwVariationenum<string>

Available options: RASPBERRY_PI_3, CAMERA_R1, CAMERA_R2, CAMERA_R2_LONG_RANGE, CAMERA_R2_180, CAMERA_R3, CAMERA_R4, CAMERA_R100, CAMERA_R120, CAMERA_R170, CAMERA_R200, CAMERA_R500, CAMERA_R510, CAMERA_R520, CAMERA_R600, SENSOR_ASSET_TAG_T1, SENSOR_DOOR_D1, SENSOR_DOOR_D20, SENSOR_ENVIRONMENTAL_E1, SENSOR_ENVIRONMENTAL_E15, SENSOR_ENVIRONMENTAL_E2, SENSOR_MOTION_M1, SENSOR_MOTION_M15, GATEWAY_A1, GATEWAY_A100, GATEWAY_ENVIRONMENTAL_E50, CAMERA_R220, CAMERA_R230, CAMERA_R36S, CAMERA_R410, CAMERA_R540, CAMERA_R545, BADGE_READER_DR1, BADGE_READER_DR40, BADGE_READER_DR20, DOOR_CONTROLLER_DC1, DOOR_CONTROLLER_DC20, DOOR_CONTROLLER_DC10, ETHERNET_TESTER_ET1, IO_BOARD_TB1, BLE_BUTTON_B10, BLE_BUTTON_B15, CAMERA_THIRD_PARTY_RELAY, CAMERA_THIRD_PARTY_NVR, CAMERA_THIRD_PARTY_NVR_MULTISENSOR, NVR_N100, CAMERA_R130, NVR_N500, CAMERA_R150, ROBOT_RC1, CAMERA_R210, CAMERA_R650, NVR_N550, NVR_N551, ROBOT_RC2, UNSPECIFIED

iaqnumber<float> | null

Indoor Air Quality index

Example: 85.5

lanAddressesstring[] | null

List of LAN IP addresses

latitudenumber<double> | null

Latitude coordinate

Example: 37.7749

leakDetectedboolean | null

Whether a leak is detected

Example: false

leakProbePresentboolean | null

Whether leak probe is present

Example: true

locationUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

longitudenumber<double> | null

Longitude coordinate

Example: -122.4194

namestring | null

Name of the environmental gateway

Example: "Main Office Gateway"

nc0p5number<float> | null

Number concentration 0.5 measurement

Example: 120.5

nc10p0number<float> | null

Number concentration 10.0 measurement

Example: 15.3

nc1p0number<float> | null

Number concentration 1.0 measurement

Example: 85.2

nc2p5number<float> | null

Number concentration 2.5 measurement

Example: 45.8

nc4p0number<float> | null

Number concentration 4.0 measurement

Example: 32.1

noxIdxnumber<float> | null

Nitrogen Oxides index

Example: 88.2

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

pm10p0number<float> | null

PM10.0 particulate matter measurement

Example: 18.9

pm1p0number<float> | null

PM1.0 particulate matter measurement

Example: 8.5

pm2p5number<float> | null

PM2.5 particulate matter measurement

Example: 12.3

pm4p0number<float> | null

PM4.0 particulate matter measurement

Example: 15.7

policyUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

pressurenumber<float> | null

Pressure measurement

Example: 1013.25

probeTempCnumber<float> | null

Temperature probe measurement in Celsius

Example: 24.5

relHumidnumber<float> | null

Relative humidity percentage

Example: 45.2

serialNumberstring | null

Serial number of the environmental gateway

Example: "EG-123456789"

smokeConfidencePercentnumber<float> | null

Smoke detection confidence percentage

Example: 92.8

smokeTobaccoConfidencePercentnumber<float> | null

Smoke tobacco detection confidence percentage

Example: 88.1

subLocationsHierarchyKeystring<SubLocationsHierarchyKey> | null

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example: "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

tempCnumber<float> | null

Temperature in Celsius

Example: 23.5

tempProbePresentboolean | null

Whether temperature probe is present

Example: true

timestampMsinteger<int64> | null

Timestamp in milliseconds

Example: 1640995200000

typPartSizenumber<float> | null

Typical particle size measurement

Example: 2.8

vapeConfidencePercentnumber<float> | null

Vape detection confidence percentage

Example: 85.5

vapeDetectedboolean | null

Whether vape is detected

Example: false

vapeThcConfidencePercentnumber<float> | null

Vape THC detection confidence percentage

Example: 72.3

vocIdxnumber<float> | null

Volatile Organic Compounds index

Example: 125.5

warningMsgstring | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.