BizKitHub
DocsAPI ReferenceIo T/bff/iot-lock/lock-list
getIo TAdmin BFF

/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

Parameters

No parameters required

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

Response schema

1 status code documented

200SuccessPaginated list of locks with metadata.
itemsobject[]Required

Array of locks matching the query criteria.

Each array item:

Single lock item in the list.

idnumberRequired

TTLock lock ID (from TTLock API).

aliasstringRequired

Display name of the lock.

electricQuantitynumberOptional

Battery level percentage (0–100).

modelNumstringOptional

Lock hardware model number.

macstringOptional

Bluetooth MAC address of the lock.

hasGatewaybooleanOptional

Whether the lock is connected to a Wi-Fi gateway.

featureValuestringOptional

TTLock feature bitmask value.

firmwareVersionstringOptional

Current firmware revision.

autoLockTimenumberOptional

Auto-lock delay in seconds (0 = disabled).

activebooleanRequired

Whether the lock is active in the system.

isOnlinebooleanRequired

Whether the lock gateway is currently online (no open outage incident).

uptimePercentnumberRequired

Gateway uptime percentage over the last 30 days (0–100).

lastOnlineDateDate | string | string | numberOptional

When the gateway was last seen online. Only present when currently offline.

One of 4:
Variant 1
Date

When the gateway was last seen online. Only present when currently offline.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
currentOutageSinceDate | string | string | numberOptional

Start of the current outage. Only present when currently offline.

One of 4:
Variant 1
Date

Start of the current outage. Only present when currently offline.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
administratorContactExternalIdstringOptional

External ID of the assigned administrator contact.

administratorNamestringOptional

Full name of the assigned administrator (or email if name is not available).

insertedDateDate | string | string | numberRequired

Date when the lock was added to the system.

One of 4:
Variant 1
Date

Date when the lock was added to the system.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
updatedDateDate | string | string | numberRequired

Date of the last status update from TTLock API.

One of 4:
Variant 1
Date

Date of the last status update from TTLock API.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
itemCountnumberRequired

Total number of non-deleted locks for pagination controls.

Response example

application/json
{
  "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
}

Request example

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"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key