Skip to content

List Devices

Returns a paginated list of all devices accessible to the current account, with basic information and current state for each device.

This is the preferred endpoint for dashboards, bulk lists, and background sync. For a single device's latest state, use Get Device.

Endpoint

http
GET /wlte/v1/devices

Authorization Requirements

ScopeRequiredDescription
device:readYesList devices accessible to the current account

Request

Full URL:

http
GET {baseUrl}/wlte/v1/devices

Request headers:

http
Authorization: Bearer {accessToken}
Accept: application/json

Query parameters:

ParameterTypeRequiredRule
pageintegerNoDefault 1, minimum 1
pageSizeintegerNoDefault 20, range 1 to 100

See Pagination Rules for the pagination field definitions.

Success Response

HTTP status:

text
200 OK

Response body:

json
{
  "code": "SUCCESS",
  "message": "OK.",
  "requestId": "req_001",
  "data": {
    "devices": [
      {
        "deviceId": "abc123456789",
        "name": "YourDeviceName-A",
        "deviceType": "SM4_T_TH",
        "status": "ONLINE",
        "peripherals": {
          "relays": [
            {
              "index": 1,
              "on": false
            },
            {
              "index": 2,
              "on": false
            },
            {
              "index": 3,
              "on": true
            },
            {
              "index": 4,
              "on": false
            }
          ],
          "digitalInputs": [
            {
              "index": 1,
              "active": false
            },
            {
              "index": 2,
              "active": false
            },
            {
              "index": 3,
              "active": false
            },
            {
              "index": 4,
              "active": false
            }
          ],
          "sensors": [
            {
              "index": 1,
              "type": "TEMP",
              "value": 30.4,
              "unit": "C",
              "status": "ONLINE"
            },
            {
              "index": 2,
              "type": "TEMP",
              "value": 32.6,
              "unit": "C",
              "status": "ONLINE"
            },
            {
              "index": 2,
              "type": "HUMI",
              "value": 54,
              "unit": "%",
              "status": "ONLINE"
            }
          ]
        },
        "stateUpdatedAt": "2026-04-29T10:28:45.258Z"
      },
      {
        "deviceId": "xyz987654321",
        "name": "YourDeviceName-B",
        "deviceType": "UNSUPPORTED",
        "status": "OFFLINE",
        "stateUpdatedAt": "2026-04-29T09:12:03.011Z"
      }
    ],
    "stats": {
      "total": 2,
      "online": 1,
      "offline": 1
    },
    "pagination": {
      "page": 1,
      "pageSize": 20,
      "total": 2,
      "totalPages": 1,
      "hasNext": false,
      "hasPrev": false
    }
  }
}

Item Rules

  • Default ordering is deviceId ascending; sorting parameters are not supported in this version
  • deviceType is the stable device capability type code
  • stats reflects the current authorized device scope, not the current page size
  • When deviceType returns UNSUPPORTED, no OpenAPI device type definition is currently available for that device, so it cannot be integrated through the standard capability model yet
  • A single sensor interface may return multiple reading types at the same index. Use index + type to identify one sensor reading

Response data Schema

FieldTypeRequiredDescription
devicesarray<Device>YesDevice list for the current page. Empty pages return []
statsobjectYesStatus counts across the current authorized device scope
stats.totalintegerYesTotal number of devices
stats.onlineintegerYesNumber of online devices
stats.offlineintegerYesNumber of offline devices
paginationobjectYesPagination information. See Pagination Rules for field details
pagination.pageintegerYesCurrent page number, starting from 1
pagination.pageSizeintegerYesCurrent page size
pagination.totalintegerYesTotal number of items
pagination.totalPagesintegerYesTotal number of pages
pagination.hasNextbooleanYesWhether a next page exists
pagination.hasPrevbooleanYesWhether a previous page exists

Device Schema

FieldTypeRequiredDescription
deviceIdstringYesUnique device identifier
namestringYesDevice display name
deviceTypestringYesDevice capability type code used to identify the device capability profile
statusstringYesDevice connectivity status. Enum: ONLINE, OFFLINE
peripheralsobjectNoCurrent device peripheral state
peripherals.relaysarray<RelayState>NoRelay state list. See Relay Outputs
peripherals.digitalInputsarray<DigitalInputState>NoDigital input state list. See Digital Inputs
peripherals.sensorsarray<SensorState>NoSensor reading list. See Sensor Readings
peripherals.analogInputsarray<AnalogInputState>NoAnalog input reading list. See Analog Input Readings
stateUpdatedAtstringYesDevice state update time in RFC3339 UTC

Error Responses

Possible responses:

  • 400 INVALID_REQUEST
  • 401 AUTH_REQUIRED
  • 401 AUTH_INVALID
  • 401 AUTH_EXPIRED
  • 403 AUTH_SCOPE_DENIED
  • 429 RATE_LIMITED
  • 500 INTERNAL_ERROR
Docs buildVersion v1.2.19-20260602-174859-60
Copyright © 2026 WLTE