/bff/iot-lock/lock-list

Returns a paginated list of TTLock smart locks for the authenticated organisation. Locks are ordered by active status, gateway connection, alias, and lock ID. Deleted locks are excluded. Each lock includes hardware metadata, battery level, and the assigned administrator contact (if any).

IoTgetBffIot-lockLock-list

No parameters

This endpoint takes no path, query, header or body parameters.

Request

GET /bff/iot-lock/lock-list

get

curl -X GET "https://api.bizkithub.com/bff/iot-lock/lock-list" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

Paginated list of locks with metadata.

{
  "items": [
    {
      "id": 0,
      "alias": "example_alias",
      "electricQuantity": 0,
      "modelNum": "example_modelNum",
      "mac": "example_mac",
      "hasGateway": false,
      "featureValue": "example_featureValue",
      "firmwareVersion": "example_firmwareVersion",
      "autoLockTime": 0,
      "active": false,
      "isOnline": false,
      "uptimePercent": 0,
      "administratorContactExternalId": "example_administratorContactExternalId",
      "administratorName": "example_administratorName"
    }
  ],
  "itemCount": 0
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key