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

/bff/iot-lock/lock-detail

Returns full detail of a specific TTLock smart lock including battery level, backup password, active/deleted status, and the assigned administrator contact information.

IoTgetBffIot-lockLock-detail

Parameters

1 query

Query parameters

· 1
idstringRequired

TTLock lock ID (from TTLock API).

Example12345

Response schema

1 status code documented

200Success
idnumberRequired

TTLock lock ID (from TTLock API).

aliasstringRequired

Display name of the lock.

electricQuantitynumberOptional

Battery level percentage (0–100).

backupPasswordstringOptional

Current system-generated backup passcode for manual unlocking.

backupPasswordInsertedDateDate | string | string | numberOptional

Date when the backup password was generated.

One of 4:
Variant 1
Date

Date when the backup password was generated.

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

Whether the lock is active in the system.

deletedbooleanRequired

Whether the lock has been soft-deleted.

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

Response example

application/json
{
  "id": 0,
  "alias": "example_alias",
  "electricQuantity": 0,
  "backupPassword": "example_backupPassword",
  "active": false,
  "deleted": false,
  "isOnline": false,
  "uptimePercent": 0,
  "administratorContactExternalId": "example_administratorContactExternalId",
  "administratorName": "example_administratorName"
}

Request example

GET /bff/iot-lock/lock-detail

get
curl -X GET "https://api.bizkithub.com/bff/iot-lock/lock-detail?id=12345" \
  -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