> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.rhombus.community/llms.txt
> Use this file to discover all available pages before exploring further.

# Get minimal climate state list

> Get basic state information of all environmental sensors



## OpenAPI

````yaml https://api2.rhombussystems.com/api/openapi/public.json post /api/climate/getMinimalClimateStateList
openapi: 3.0.1
info:
  contact:
    email: developer@rhombussystems.com
  description: >-
    This API is for use by Rhombus customers and partners.


    ## Authentication


    All requests require two headers:

    - `x-auth-scheme` — The authentication scheme identifier. Use `api-token`
    for standard API key auth, or `partner-api-token` for partner API auth.

    - `x-auth-apikey` — Your Rhombus API key.


    Example:

    ```

    POST /api/camera/getMinimalCameraStateList

    x-auth-scheme: api-token

    x-auth-apikey: YOUR_API_KEY

    Content-Type: application/json

    ```
  title: Rhombus API
  version: '1.0'
servers:
  - description: Production Server
    url: https://api2.rhombussystems.com
security:
  - ApiKeyAuth: []
paths:
  /api/climate/getMinimalClimateStateList:
    post:
      tags:
        - Climate Webservice
      summary: Get minimal climate state list
      description: Get basic state information of all environmental sensors
      operationId: getMinimalClimateStateList
      parameters:
        - description: >-
            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.
          example: api-token
          in: header
          name: x-auth-scheme
          required: true
          schema:
            type: string
            default: api-token
            enum:
              - api-token
              - api
              - partner-api-token
              - partner-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Climate_GetMinimalClimateStatesWSRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Climate_GetMinimalClimateStatesWSResponse'
          description: OK
components:
  schemas:
    Climate_GetMinimalClimateStatesWSRequest:
      type: object
      description: >-
        Request to retrieve minimal climate state information for all
        environmental sensors.
    Climate_GetMinimalClimateStatesWSResponse:
      type: object
      description: >-
        Response containing minimal climate state information for environmental
        sensors.
      properties:
        climateStates:
          type: array
          description: List of minimal climate state information
          items:
            $ref: '#/components/schemas/Climate_MinimalClimateStateType'
          nullable: true
        error:
          type: boolean
          nullable: true
        errorMsg:
          type: string
          nullable: true
        warningMsg:
          type: string
          nullable: true
    Climate_MinimalClimateStateType:
      type: object
      description: Minimal climate state information for environmental sensors.
      properties:
        associatedCameras:
          type: array
          description: List of associated camera device facet UUIDs
          items:
            type: string
            format: DeviceFacetUuid
            description: RUUID with optional appended facet information
            example: AAAAAAAAAAAAAAAAAAAAAA.v0
            nullable: true
          nullable: true
        batteryPercent:
          type: integer
          format: int32
          description: Battery percentage of the environmental sensor
          example: 85
          nullable: true
        calibrating:
          type: boolean
          description: Whether the sensor is currently calibrating
          example: false
          nullable: true
        closestBaseStation:
          type: string
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
        co2:
          type: number
          format: float
          description: CO2 measurement
          example: 450
          nullable: true
        createdAtMillis:
          type: integer
          format: int64
          description: Creation timestamp in milliseconds
          example: 1640995200000
          nullable: true
        ethanol:
          type: number
          format: float
          description: Ethanol measurement
          example: 5.2
          nullable: true
        firmwareVersion:
          type: string
          description: Firmware version
          example: 1.2.3
          nullable: true
        floorNumber:
          type: integer
          format: int32
          description: Floor number
          example: 2
          nullable: true
        health:
          $ref: '#/components/schemas/Climate_ClimateHealthEnum'
        healthDetails:
          $ref: '#/components/schemas/Climate_ClimateHealthDetailsEnum'
        heatIndexDegF:
          type: number
          format: double
          description: Heat index in degrees Fahrenheit
          example: 85.2
          nullable: true
        heatIndexRangeWarning:
          $ref: '#/components/schemas/HeatIndexRangeWarningEnum'
        humidity:
          type: number
          format: float
          description: Relative humidity percentage
          example: 45.2
          nullable: true
        hwVariation:
          $ref: '#/components/schemas/HardwareVariationEnum'
        iaq:
          type: number
          format: float
          description: Indoor Air Quality index
          example: 85.5
          nullable: true
        lastSeenSec:
          type: integer
          format: int64
          description: Last seen timestamp in seconds
          example: 1640995200
          nullable: true
        latitude:
          type: number
          format: double
          description: Latitude coordinate
          example: 37.7749
          nullable: true
        locationUuid:
          type: string
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
        longitude:
          type: number
          format: double
          description: Longitude coordinate
          example: -122.4194
          nullable: true
        name:
          type: string
          description: Name of the environmental sensor
          example: Office Climate Sensor
          nullable: true
        pm25:
          type: number
          format: float
          description: PM2.5 particulate matter measurement
          example: 12.3
          nullable: true
        policyUuid:
          type: string
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
        probeConnected:
          type: boolean
          description: Whether the probe is connected
          example: true
          nullable: true
        probeTempC:
          type: number
          format: float
          description: Temperature probe measurement in Celsius
          example: 24.1
          nullable: true
        sensorUuid:
          type: string
          format: RUUID
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
        serialNumber:
          type: string
          description: Serial number of the environmental sensor
          example: ES-123456789
          nullable: true
        signalStrength:
          type: integer
          format: int32
          description: Signal strength of the environmental sensor
          example: 85
          nullable: true
        subLocationsHierarchyKey:
          type: string
          format: SubLocationsHierarchyKey
          description: |
            A sequence of one or more base 64 (url-safe) uuid substrings.
            These substrings are separated by dots (.).
          example: AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA
          nullable: true
          pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$
        temperatureCelcius:
          type: number
          format: float
          description: Temperature in Celsius
          example: 23.5
          nullable: true
        thcPercent:
          type: number
          format: float
          description: THC percentage measurement
          example: 0.8
          nullable: true
        tvoc:
          type: number
          format: float
          description: Total Volatile Organic Compounds (TVOC) measurement
          example: 125.5
          nullable: true
        vapePercent:
          type: number
          format: float
          description: Vape percentage measurement
          example: 2.1
          nullable: true
    Climate_ClimateHealthEnum:
      type: string
      description: Health status enumeration for climate sensors.
      enum:
        - GREEN
        - RED
    Climate_ClimateHealthDetailsEnum:
      type: string
      description: Detailed health status enumeration for climate sensors.
      enum:
        - FIRMWARE_BEHIND
        - NO_HEARTBEAT
        - NONE
    HeatIndexRangeWarningEnum:
      type: string
      description: Heat index range warning status
      enum:
        - HEAT_INDEX_OK
        - HEAT_INDEX_WARNING
        - HEAT_INDEX_UNSUPPORTED
    HardwareVariationEnum:
      type: string
      enum:
        - 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
        - NVR_N100
        - CAMERA_R130
        - NVR_N500
        - CAMERA_R150
        - ROBOT_RC1
        - CAMERA_R210
        - CAMERA_R650
        - UNSPECIFIED
  securitySchemes:
    ApiKeyAuth:
      description: >-
        Your Rhombus API key. Must be accompanied by the `x-auth-scheme` header
        set to `api-token` (or `partner-api-token` for partner endpoints).
      in: header
      name: x-auth-apikey
      type: apiKey

````