SensorLinx by HBX ControlsReference
v1.0.0
OAS 3.1.1

SensorLinx Connect API

Introduction

The SensorLinx Connect API provides users of the SensorLinx™ by HBX Controls system with programmatic access to real-time and historical data from their connected devices. Designed for seamless integration, the API enables developers to create custom applications and tools to monitor, analyze, and optimize HVAC, solar thermal, and geothermal systems.

Download the mobile app

Client Libraries
Curl Shell

Device​

Monitor and manage device information in your system

Device Endpoints

Retrieve device brief​

Fetches a list of all devices available in the current building, including metadata such as device name, type, and unique identifiers. This endpoint does not include real-time data or device status, making it ideal for retrieving a lightweight overview of available devices.

Query Parameters
  • limit
    integer int64
    default: 
    25

    The maximum number of records to return in a single response. Used for pagination to control the dataset size.

  • page
    integer int64
    default: 
    1

    The page number of the results to retrieve. Used for pagination to navigate through data in sequential pages.

Responses
GET/devices/available


{
  "items": [
    {
      "connectedAt": "2024-04-16T21:36:29.664Z",
      "syncCode": "AECO-4321",
      "deviceType": "ECO",
      "firmVer": 1.22
    }
  ],
  "totalItems": 44,
  "totalPages": 3,
  "offset": 0,
  "limit": 20,
  "page": 1,
  "pagingCounter": 1,
  "hasPrevPage": false,
  "hasNextPage": true,
  "nextPage": 2,
  "prevPage": null
}

OK

History​

History Endpoints

Models