> ## Documentation index
> Fetch the complete documentation index at: https://developer.rhombus.com/llms.txt
> Use it to discover all available pages before exploring further.

# Get events for environmental gateway

> Get list of events for environmental gateway

```http
POST https://api2.rhombussystems.com/api/climate/getEventsForEnvironmentalGateway
```

EU organizations send the same request to `https://api2.eu.rhombussystems.com`.

## Authentication and parameters

- `x-auth-apikey` (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).
- `Authorization` (header): instead of an API key, an OAuth access token (`Bearer <token>`) with the `read` scope.
- `x-auth-scheme` (header, string, default: `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. One of: `api-token`, `api`, `api-oauth-token`, `federated-token`, `partner-api-token`, `partner-api`, `partner-api-oauth-token`.
- `x-auth-org` (header, string<RUUID>): 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`.

## Request body

Content type: `application/json`. Request to retrieve events for an environmental gateway.

- `createdAfterMs` (integer<int64> | null): Timestamp in milliseconds after which events should be retrieved
- `createdBeforeMs` (integer<int64> | null): Timestamp in milliseconds before which events should be retrieved
- `deviceUuid` (string<RUUID> | null): base 64 (url-safe) uuid string
- `lastEvaluatedKey` (string | null)
- `maxPageSize` (integer<int32> | null): Maximum number of results to return per page

## Response 200

OK. Content type: `application/json`

- `events` (array<object> | null): List of climate events for the environmental gateway
- `lastEvaluatedKey` (string | null)

## Errors

Also 400, 401, 403, 429, 500, 503 with the standard error body (`errorCode`, `errorMsg`): https://developer.rhombus.com/errors

## OpenAPI

````yaml
openapi: 3.0.1
info:
  title: Rhombus API
  version: "1.0"
servers:
  - description: Production Server
    url: https://api2.rhombussystems.com
security:
  - ApiKeyAuth: []
paths:
  /api/climate/getEventsForEnvironmentalGateway:
    post:
      description: Get list of events for environmental gateway
      operationId: getEventsForEnvironmentalGateway
      parameters:
        - description: "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."
          example: api-token
          in: header
          name: x-auth-scheme
          required: false
          schema:
            default: api-token
            enum:
              - api-token
              - api
              - api-oauth-token
              - federated-token
              - partner-api-token
              - partner-api
              - partner-api-oauth-token
            type: string
        - description: "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`."
          in: header
          name: x-auth-org
          required: false
          schema:
            format: RUUID
            maxLength: 22
            minLength: 22
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/Climate_GetEventsForEnvironmentalGatewayWSRequest"
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Climate_GetEventsForEnvironmentalGatewayWSResponse"
          description: OK
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "429":
          $ref: "#/components/responses/TooManyRequests"
        "500":
          $ref: "#/components/responses/InternalServerError"
        "503":
          $ref: "#/components/responses/ServiceUnavailable"
      security:
        - ApiKeyAuth: []
        - oauth2:
            - read
      summary: Get events for environmental gateway
      tags:
        - Climate Webservice
components:
  schemas:
    Climate_GetEventsForEnvironmentalGatewayWSRequest:
      description: Request to retrieve events for an environmental gateway.
      properties:
        createdAfterMs:
          description: Timestamp in milliseconds after which events should be retrieved
          example: 1640991600000
          format: int64
          nullable: true
          type: integer
        createdBeforeMs:
          description: Timestamp in milliseconds before which events should be retrieved
          example: 1640995200000
          format: int64
          nullable: true
          type: integer
        deviceUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        lastEvaluatedKey:
          nullable: true
          type: string
        maxPageSize:
          description: Maximum number of results to return per page
          example: 50
          format: int32
          nullable: true
          type: integer
      type: object
    Climate_GetEventsForEnvironmentalGatewayWSResponse:
      description: Response containing events for an environmental gateway.
      properties:
        events:
          description: List of climate events for the environmental gateway
          items:
            $ref: "#/components/schemas/E50ClimateEventType"
          nullable: true
          type: array
        lastEvaluatedKey:
          nullable: true
          type: string
      type: object
    E50ClimateEventType:
      description: List of climate events for the environmental gateway
      properties:
        activities:
          items:
            $ref: "#/components/schemas/ActivityEnum"
          nullable: true
          type: array
        alertTriggerThresholds:
          items:
            format: double
            nullable: true
            type: number
          nullable: true
          type: array
        alertTriggers:
          items:
            $ref: "#/components/schemas/ActivityEnum"
          nullable: true
          type: array
        carbonMonoSense:
          $ref: "#/components/schemas/COSensorType"
        clipMetaData:
          $ref: "#/components/schemas/ClipMetaDataType"
        co2Sense:
          $ref: "#/components/schemas/Co2SensorType"
        derivedValues:
          $ref: "#/components/schemas/E50DerivedValuesType"
        deviceType:
          $ref: "#/components/schemas/DeviceTypeEnum"
        deviceUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        firmwareVersion:
          nullable: true
          type: string
        formaSense:
          $ref: "#/components/schemas/FormaSensorType"
        hwVariation:
          $ref: "#/components/schemas/HardwareVariationEnum"
        leakProbe:
          $ref: "#/components/schemas/LeakProbeType"
        orgUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        pmSense:
          $ref: "#/components/schemas/PmSensorType"
        policyUuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
        pressSense:
          $ref: "#/components/schemas/PressureSensorType"
        tempProbe:
          $ref: "#/components/schemas/TempProbeType"
        timestampMs:
          format: int64
          nullable: true
          type: integer
        uuid:
          description: base 64 (url-safe) uuid string
          example: AAAAAAAAAAAAAAAAAAAAAA
          format: RUUID
          nullable: true
          type: string
      type: object
    ActivityEnum:
      enum:
        - SOUND_LOUD
        - SOUND_GUN_SHOT
        - TAMPER
        - VISUAL_TAMPER
        - MOTION_TAMPER
        - MOTION
        - MOTION_HUMAN
        - MOTION_CAR
        - MOTION_ANIMAL
        - MOTION_PACKAGE
        - PACKAGE_ARRIVED
        - PACKAGE_DEPARTED
        - FACE
        - FACE_IDENTIFIED
        - FACE_UNIDENTIFIED
        - FACE_BLACKLISTED
        - FACE_ALERT
        - POSE_ANOMALOUS
        - POSE_FALL
        - LICENSEPLATE
        - LICENSEPLATE_IDENTIFIED
        - LICENSEPLATE_UNIDENTIFIED
        - LICENSEPLATE_ALERT
        - LICENSEPLATE_BLACKLISTED
        - LICENSEPLATE_TRUSTED
        - PEOPLECOUNT_HIGH
        - PEOPLECOUNT_HIGH_RESET
        - PEOPLECOUNT_LOW
        - PEOPLECOUNT_LOW_RESET
        - HUMAN_ENTER
        - HUMAN_EXIT
        - CAR_ENTER
        - CAR_EXIT
        - TEMPERATURE_EXCEEDED_HIGH
        - TEMPERATURE_EXCEEDED_LOW
        - HUMIDITY_EXCEEDED_HIGH
        - HUMIDITY_EXCEEDED_LOW
        - PM25_EXCEEDED_HIGH
        - TVOC_EXCEEDED_HIGH
        - ETOH_EXCEEDED_HIGH
        - IAQ_EXCEEDED_HIGH
        - CO2_EXCEEDED_HIGH
        - CO2_EXCEEDED_LOW
        - PROBE_TEMPERATURE_EXCEEDED_HIGH
        - PROBE_TEMPERATURE_EXCEEDED_LOW
        - PROBE_DISCONNECTED
        - PROBE_CONNECTED
        - HEAT_INDEX_EXCEEDED_HIGH
        - PRESSURE_EXCEEDED_HIGH
        - PRESSURE_EXCEEDED_LOW
        - PM10_EXCEEDED_HIGH
        - PM40_EXCEEDED_HIGH
        - PM100_EXCEEDED_HIGH
        - VOC_IDX_EXCEEDED_HIGH
        - NOX_IDX_EXCEEDED_HIGH
        - FORMALDEHYDE_EXCEEDED_HIGH
        - CARBON_MONOXIDE_EXCEEDED_HIGH
        - AQI_EXCEEDED_HIGH
        - DOOR_AJAR
        - DOOR_OPENED
        - DOOR_CLOSED
        - BUTTON_SINGLE_PRESSED
        - BUTTON_DOUBLE_PRESSED
        - BUTTON_LONG_PRESSED
        - TAG_ARRIVED
        - TAG_DEPARTED
        - TAG_MOVED
        - TAG_POSITIONING_CHANGED
        - TAG_BOUNDARY_INGRESS
        - TAG_BOUNDARY_EGRESS
        - TAG_PANIC
        - BADGE_AUTHORIZED
        - BADGE_UNAUTHORIZED
        - BADGE_UNAUTHORIZED_V2
        - BADGE_AJAR
        - BADGE_MANUAL
        - BADGE_FORCED_OPEN
        - BADGE_LOCKDOWN
        - BADGE_REQUEST_TO_EXIT
        - BADGE_DURESS
        - BADGE_SECURITY_BREACH
        - BADGE_TAMPER
        - BADGE_FACE_MISMATCH
        - POS_ORDER
        - GUN_DETECT_EVENT
        - IOT_SOUND_AGGRESSION
        - IOT_SOUND_HELP
        - IOT_AIR_CO
        - IOT_AIR_CO2
        - IOT_AIR_MASKING
        - IOT_AIR_THC
        - IOT_AIR_VAPE
        - IOT_AIR_VOC
        - IOT_AIR_TEMP
        - IOT_TAMPER
        - IOT_GUNSHOT
        - IOT_BUTTON_SINGLE_CLICK
        - IOT_BUTTON_DOUBLE_CLICK
        - IOT_BUTTON_HOLD
        - IOT_PANIC_BUTTON_TRIGGERED
        - AUDIO_SOUND_SIGNIFICANT
        - AUDIO_SOUND_LOUD
        - AUDIO_SOUND_ABUSIVE
        - AUDIO_SOUND_GREETING
        - AUDIO_SOUND_HELP
        - AUDIO_SOUND_GUN
        - AUDIO_SOUND_GLASS_BREAK
        - AUDIO_SOUND_ALARM_SMOKE_FIRE
        - AUDIO_SOUND_ALARM_CARBON_MONOXIDE
        - AUDIO_SOUND_SIREN
        - CLIMATE_VOC
        - CLIMATE_VAPE
        - CLIMATE_SMOKE
        - CLIMATE_THC
        - CLIMATE_CO2
        - CLIMATE_ETOH
        - CLIMATE_PM25
        - CLIMATE_IAQ
        - CLIMATE_LEAK
        - SOUND_AGGRESSION
        - SOUND_HELP
        - AIR_CO
        - AIR_CO2
        - AIR_MASKING
        - AIR_THC
        - AIR_VAPE
        - AIR_VOC
        - MASK_MISSING
        - HELMET_MISSING
        - GLOVES_MISSING
        - PIR_OCCUPIED
        - PIR_MOVEMENT
        - PIR_VACANT
        - CUSTOM
        - VISITOR_ARRIVED
        - VISITOR_DEPARTED
        - AC_DR_CONNECTED
        - AC_DR_DISCONNECTED
        - AC_DPI_DOOR_OPEN
        - AC_DPI_DOOR_CLOSED
        - AC_DPI_DOOR_AJAR
        - AC_DPI_DOOR_FORCED_OPEN
        - AC_DSR_UNLOCKED
        - AC_DSR_LOCKED
        - AC_DB_TRIGGERED
        - AC_PANIC_BUTTON_TRIGGERED
        - AC_REMOTE_UNLOCK
        - AC_BADGE_AUTHORIZED
        - AC_BADGE_UNAUTHORIZED
        - AC_BADGE_FACE_MISMATCH
        - AC_LOCKDOWN_ACTIVATED
        - AC_LOCKDOWN_DEACTIVATED
        - AC_LOCKDOWN_PLAN_SWITCHED
        - AC_TAMPER_PROX
        - AC_TAMPER_ACCEL
        - AC_TAMPER_SWITCH
        - AC_GR_ACTIVE
        - AC_GR_INACTIVE
        - AC_GI_ACTIVE
        - AC_GI_INACTIVE
        - AC_REX_ACTIVE
        - AC_REX_INACTIVE
        - AC_APERIO_DEVICE_DISCONNECTED
        - AC_APERIO_DEVICE_CONNECTED
        - AC_APERIO_DEVICE_REBOOT
        - AC_APERIO_DEVICE_TAMPER
        - AC_APERIO_LOW_BATTERY
        - AC_APERIO_FLAT_BATTERY
        - AC_APERIO_OK_BATTERY
        - AC_SCHLAGE_GW_DISCONNECTED
        - AC_SCHLAGE_GW_CONNECTED
        - AC_SCHLAGE_APM_DISCONNECTED
        - AC_SCHLAGE_APM_CONNECTED
        - AC_SCHLAGE_LOW_BATTERY
        - AC_SCHLAGE_CRITICAL_BATTERY
        - AC_SCHLAGE_OK_BATTERY
        - POWER_SWITCH_BATTERY
        - POWER_SWITCH_PRIMARY
        - AI_SEARCH_MATCH
        - AI_SEARCH_MATCH_PERSON_SMOKING
        - AI_SEARCH_MATCH_PERSON_ON_PHONE
        - AI_SEARCH_MATCH_PERSON_FALLING
        - CUSTOM_LLM_BOOLEAN_TRUE
        - CUSTOM_LLM_BOOLEAN_FALSE
        - CUSTOM_LLM_THRESHOLD_EXCEEDED_LOW
        - CUSTOM_LLM_THRESHOLD_EXCEEDED_HIGH
        - ALM_AUTHORITIES_CONTACTED
        - ALM_MONITORING_ENABLED
        - ALM_MONITORING_DISABLED
        - ALM_MONITORING_SETTINGS_CHANGE
        - ALM_THREAT_CASE_CLOSED
        - ALM_THREAT_DETECTED
        - ALM_MONITORING_EVENT_DETECTED
        - ROBOT_DOG_DETECTED
        - ROBOT_ARRIVED_AT_WAYPOINT
        - ROBOT_ARRIVED_AT_POSE
        - ROBOT_WAITING_AT_POSE
        - ROBOT_MANUAL_CMD_VEL
        - ROBOT_MANUAL_ACTION
        - ROBOT_MANUAL_POSTURE
        - ROBOT_NAVIGATE_TO_POSE_START
        - ROBOT_NAVIGATE_TO_POSE_END
        - ROBOT_NAVIGATE_TO_HOME_START
        - ROBOT_NAVIGATE_TO_HOME_END
        - ROBOT_NAVIGATE_TO_WAYPOINT_START
        - ROBOT_NAVIGATE_TO_WAYPOINT_END
        - ROBOT_ROUTE_RUN_START
        - ROBOT_ROUTE_RUN_END
        - ROBOT_LOW_BATTERY_DOCKING
        - ROBOT_IDLE_DOCKING
        - ROBOT_EMERGENCY
        - LOITER_HUMAN
        - INACTIVITY_HUMAN
        - INACTIVITY_CAR
        - GROUP_ENTRY
        - ONGUARD_BADGE_AUTHORIZED
        - ONGUARD_BADGE_ANOMALY
        - ONGUARD_NO_ENTRY_MADE
        - ELEMENTS_BADGE_AUTHORIZED
        - ELEMENTS_BADGE_ANOMALY
        - ELEMENTS_NO_ENTRY_MADE
        - NETBOX_BADGE_AUTHORIZED
        - NETBOX_BADGE_ANOMALY
        - NETBOX_NO_ENTRY_MADE
        - THERMAL_TEMPERATURE_ALARM
        - THERMAL_TEMPERATURE_WARNING
        - THERMAL_FIRE_DETECTED
        - THERMAL_SMOKING_DETECTED
        - THERMAL_FIRE_VERIFIED
        - THERMAL_HEAT_NO_THREAT
        - THERMAL_VISUAL_HOTSPOT
        - THERMAL_VISUAL_HEAT_RISE
        - THERMAL_VISUAL_WARM_BODY
        - UNKNOWN
      type: string
    COSensorType:
      properties:
        adcRaw:
          format: int32
          nullable: true
          type: integer
        adcVoltage:
          format: double
          nullable: true
          type: number
        coConcentration:
          format: double
          nullable: true
          type: number
        timestampSec:
          format: int64
          nullable: true
          type: integer
      type: object
    ClipMetaDataType:
      properties:
        activitySeekPoints:
          additionalProperties:
            items:
              format: float
              nullable: true
              type: number
            nullable: true
            type: array
          nullable: true
          type: object
        activitySeekPointsV2:
          items:
            $ref: "#/components/schemas/ClipSeekPointType"
          nullable: true
          type: array
        activitySeekPointsV3:
          items:
            $ref: "#/components/schemas/ClipSeekPointV2Type"
          nullable: true
          type: array
        boundingBoxes:
          items:
            $ref: "#/components/schemas/ClipBoundingBoxType"
          nullable: true
          type: array
        clipLocation:
          $ref: "#/components/schemas/MetaDataLocationType"
        durationSec:
          format: int32
          nullable: true
          type: integer
        mGrids:
          items:
            nullable: true
            type: string
          nullable: true
          type: array
        soundSignificantLufs:
          items:
            format: int32
            nullable: true
            type: integer
          nullable: true
          type: array
        startTime:
          format: int64
          nullable: true
          type: integer
        thumbnailLocation:
          $ref: "#/components/schemas/MetaDataLocationType"
        thumbnailLocationV2:
          nullable: true
          type: string
      type: object
    ClipSeekPointType:
      properties:
        activity:
          $ref: "#/components/schemas/ActivityEnum"
        alert:
          nullable: true
          type: boolean
        bottom:
          format: float
          nullable: true
          type: number
        faceName:
          nullable: true
          type: string
        keypointsV2:
          additionalProperties:
            $ref: "#/components/schemas/PointType"
          nullable: true
          type: object
        left:
          format: float
          nullable: true
          type: number
        licensePlate:
          nullable: true
          type: string
        pose:
          nullable: true
          type: string
        relativeSecond:
          format: float
          nullable: true
          type: number
        right:
          format: float
          nullable: true
          type: number
        top:
          format: float
          nullable: true
          type: number
        unidentifiedFaceId:
          nullable: true
          type: string
        vehicleName:
          nullable: true
          type: string
      type: object
    PointType:
      properties:
        x:
          format: int32
          nullable: true
          type: integer
        y:
          format: int32
          nullable: true
          type: integer
      type: object
    ClipSeekPointV2Type:
      description: List of seek points for the clip
      properties:
        activity:
          $ref: "#/components/schemas/ActivityEnum"
        alert:
          nullable: true
          type: boolean
        customActivityColor:
          $ref: "#/components/schemas/FootageSeekPointColorEnum"
        customActivityDescription:
          nullable: true
          type: string
        customActivityDisplayName:
          nullable: true
          type: string
        dcao:
          nullable: true
          type: boolean
        dwelling:
          nullable: true
          type: boolean
        faceName:
          nullable: true
          type: string
        id:
          format: int32
          nullable: true
          type: integer
        inMotion:
          nullable: true
          type: boolean
        licensePlate:
          nullable: true
          type: string
        loudness:
          format: int32
          nullable: true
          type: integer
        pose:
          nullable: true
          type: string
        relativeSecond:
          format: float
          nullable: true
          type: number
        sensorValType:
          $ref: "#/components/schemas/SensorValType"
        stableTrackId:
          format: int32
          nullable: true
          type: integer
        toastOrderIdInfo:
          $ref: "#/components/schemas/ToastOrderIdType"
        tu:
          nullable: true
          type: string
        unidentifiedFaceId:
          nullable: true
          type: string
        vehicleName:
          nullable: true
          type: string
      type: object
    FootageSeekPointColorEnum:
      enum:
        - BLUE
        - RED
        - PURPLE
        - TAN
        - ORANGE
        - TEAL
        - GRAY
        - BLACK
      type: string
    SensorValType:
      properties:
        sensorBoolean:
          nullable: true
          type: boolean
        sensorDouble:
          format: double
          nullable: true
          type: number
        sensorLong:
          format: int64
          nullable: true
          type: integer
      type: object
    ToastOrderIdType:
      properties:
        employeeName:
          nullable: true
          type: string
        guid:
          nullable: true
          type: string
        locationName:
          nullable: true
          type: string
        restaurantName:
          nullable: true
          type: string
        toastCheckInfo:
          $ref: "#/components/schemas/ToastCheckInfo"
      type: object
    ToastCheckInfo:
      properties:
        totalAmount:
          format: double
          nullable: true
          type: number
      type: object
    ClipBoundingBoxType:
      properties:
        activity:
          $ref: "#/components/schemas/ActivityEnum"
        alert:
          nullable: true
          type: boolean
        bottom:
          format: int32
          nullable: true
          type: integer
        confidence:
          format: float
          nullable: true
          type: number
        croppedImageLocator:
          nullable: true
          type: string
        customActivityColor:
          $ref: "#/components/schemas/FootageSeekPointColorEnum"
        customActivityDescription:
          nullable: true
          type: string
        customActivityDisplayName:
          nullable: true
          type: string
        dwelling:
          nullable: true
          type: boolean
        faceName:
          nullable: true
          type: string
        inMotion:
          nullable: true
          type: boolean
        keypointsV2:
          additionalProperties:
            $ref: "#/components/schemas/PointType"
          nullable: true
          type: object
        left:
          format: int32
          nullable: true
          type: integer
        licensePlate:
          nullable: true
          type: string
        loudness:
          format: int32
          nullable: true
          type: integer
        objectId:
          format: int32
          nullable: true
          type: integer
        pose:
          nullable: true
          type: string
        relativeSecond:
          format: float
          nullable: true
          type: number
        right:
          format: int32
          nullable: true
          type: integer
        sensorValType:
          $ref: "#/components/schemas/SensorValType"
        stableTrackId:
          format: int32
          nullable: true
          type: integer
        toastOrderIdInfo:
          $ref: "#/components/schemas/ToastOrderIdType"
        top:
          format: int32
          nullable: true
          type: integer
        unidentifiedFaceId:
          nullable: true
          type: string
        vehicleName:
          nullable: true
          type: string
      type: object
    MetaDataLocationType:
      properties:
        region:
          nullable: true
          type: string
      type: object
    Co2SensorType:
      properties:
        co2Ppm:
          format: int32
          nullable: true
          type: integer
        relHumid:
          format: float
          nullable: true
          type: number
        tempC:
          format: float
          nullable: true
          type: number
        timestampSec:
          format: int64
          nullable: true
          type: integer
      type: object
    E50DerivedValuesType:
      properties:
        airQualityIndex:
          format: int32
          nullable: true
          type: integer
        airQualityIndexPollutant:
          $ref: "#/components/schemas/AirQualityIndexPollutantEnum"
        calibrating:
          nullable: true
          type: boolean
        deviceOrientation:
          $ref: "#/components/schemas/DeviceOrientationEnum"
        falsePositiveConfidencePercent:
          format: float
          nullable: true
          type: number
        heatIndexDegF:
          format: double
          nullable: true
          type: number
        heatIndexRangeWarning:
          $ref: "#/components/schemas/HeatIndexRangeWarningEnum"
        indoorAirQuality:
          format: float
          nullable: true
          type: number
        malfunctioningModules:
          items:
            nullable: true
            type: string
          nullable: true
          type: array
        smokeConfidencePercent:
          format: float
          nullable: true
          type: number
        smokeThcConfidencePercent:
          format: float
          nullable: true
          type: number
        smokeTobaccoConfidencePercent:
          format: float
          nullable: true
          type: number
        timestampSec:
          format: int64
          nullable: true
          type: integer
        tvoc:
          format: float
          nullable: true
          type: number
        vapeConfidencePercent:
          format: float
          nullable: true
          type: number
        vapeDetected:
          nullable: true
          type: boolean
        vapeThcConfidencePercent:
          format: float
          nullable: true
          type: number
      type: object
    AirQualityIndexPollutantEnum:
      description: Primary pollutant affecting air quality index
      enum:
        - OZONE
        - PM2P5
        - PM10P0
        - CO
        - NO2
        - SO2
        - UNKNOWN
      type: string
    DeviceOrientationEnum:
      enum:
        - CEILING
        - FLOOR
        - WALL
        - WALL_CROOKED
        - INDETERMINATE
      type: string
    HeatIndexRangeWarningEnum:
      description: Heat index range warning status
      enum:
        - HEAT_INDEX_OK
        - HEAT_INDEX_WARNING
        - HEAT_INDEX_UNSUPPORTED
      type: string
    DeviceTypeEnum:
      enum:
        - BLE_TRACKER
        - CAMERA
        - DOOR_SENSOR
        - ENVIRONMENTAL_SENSOR
        - OCCUPANCY_SENSOR
        - AUDIO_GATEWAY
        - EXECUTABLE
        - BADGE_READER
        - DOOR_CONTROLLER
        - BLE_BUTTON
        - IO_BOARD
        - ENVIRONMENTAL_GATEWAY
        - NVR
        - ROBOT
        - UNKNOWN
      type: string
    FormaSensorType:
      properties:
        ch2oPpb:
          format: float
          nullable: true
          type: number
        relHumid:
          format: float
          nullable: true
          type: number
        tempC:
          format: float
          nullable: true
          type: number
        timestampSec:
          format: int64
          nullable: true
          type: integer
      type: object
    HardwareVariationEnum:
      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
        - 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
      type: string
    LeakProbeType:
      properties:
        adcMv:
          format: float
          nullable: true
          type: number
        adcRaw:
          format: int64
          nullable: true
          type: integer
        leakDetected:
          nullable: true
          type: boolean
        moistDetected:
          nullable: true
          type: boolean
        present:
          nullable: true
          type: boolean
        timestampSec:
          format: int64
          nullable: true
          type: integer
      type: object
    PmSensorType:
      properties:
        nc0p5:
          format: float
          nullable: true
          type: number
        nc10p0:
          format: float
          nullable: true
          type: number
        nc1p0:
          format: float
          nullable: true
          type: number
        nc2p5:
          format: float
          nullable: true
          type: number
        nc4p0:
          format: float
          nullable: true
          type: number
        noxIdx:
          format: float
          nullable: true
          type: number
        pm10p0:
          format: float
          nullable: true
          type: number
        pm1p0:
          format: float
          nullable: true
          type: number
        pm2p5:
          format: float
          nullable: true
          type: number
        pm4p0:
          format: float
          nullable: true
          type: number
        relHumid:
          format: float
          nullable: true
          type: number
        tempC:
          format: float
          nullable: true
          type: number
        timestampSec:
          format: int64
          nullable: true
          type: integer
        typPartSize:
          format: float
          nullable: true
          type: number
        vocIdx:
          format: float
          nullable: true
          type: number
      type: object
    PressureSensorType:
      properties:
        pressure:
          format: float
          nullable: true
          type: number
        tempC:
          format: float
          nullable: true
          type: number
        timestampSec:
          format: int64
          nullable: true
          type: integer
      type: object
    TempProbeType:
      properties:
        adcMv:
          format: float
          nullable: true
          type: number
        adcRaw:
          format: int64
          nullable: true
          type: integer
        present:
          nullable: true
          type: boolean
        tempC:
          format: float
          nullable: true
          type: number
        timestampSec:
          format: int64
          nullable: true
          type: integer
      type: object
  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
    oauth2:
      description: 'OAuth 2.0 authorization code flow with PKCE (`S256`). Send the access token as `Authorization: Bearer <token>`. Each operation lists the scopes it requires; a token without them is refused 403 with `WWW-Authenticate: Bearer error="insufficient_scope"`.'
      flows:
        authorizationCode:
          authorizationUrl: https://console.rhombus.com/oauth/authorize
          refreshUrl: https://auth-web.rhombussystems.com/oauth/token
          scopes:
            physical: Unlock doors and elevators, lockdown, alarms, speakers and robots
            read: View cameras, footage and settings
            write: Change settings and data
          tokenUrl: https://auth-web.rhombussystems.com/oauth/token
      type: oauth2
````
