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

/bff/iot-lock/unlock-record-list

Returns a paginated list of unlock/lock history records for a specific lock. Each record includes the action type (unlock, lock, auto-lock, etc.), success status, timestamp, and the keyboard password used (if applicable). Record type labels are translated based on the provided locale.

IoTgetBffIot-lockUnlock-record-list

Parameters

2 query

Query parameters

· 2
idstringRequired

TTLock lock ID (from TTLock API).

Example12345
localestringOptional

Communication locale code — controls the language of textual data (product names, descriptions, articles, storefront UI, transactional e-mails).

Preferred format: BCP 47 language tag — language[-Script][-REGION]. Use the full tag whenever the script or region matters:

  • en-GB vs. en-US (British vs. American spelling)
  • pt-PT vs. pt-BR (European vs. Brazilian Portuguese)
  • zh-Hans vs. zh-Hant (Simplified vs. Traditional Chinese)
  • sr-Latn vs. sr-Cyrl (Latin vs. Cyrillic Serbian)

Backwards-compatible fallback: the bare two-letter ISO 639-1 code (cs, en, pl, …) is accepted indefinitely — legacy clients that only send the language subtag continue to work unchanged.

Resolution algorithm (server-side): the input is resolved against the supported locale list via the [RFC 4647 Lookup] progressive-fallback strategy — trailing subtags are stripped one by one until a supported locale is found. Example: en-GB-oxendict → en-GB → en (matched). If no subtag combination is supported, the request is rejected.

Currently supported locales: cs, en, fr, it, pl, de, sk, sv, es, zh, ja, uk, da, hu, ro, nl, pt, fi, nb, hr. Region-specific variants (e.g. en-GB, pt-BR) are accepted and resolved to their base language when the exact variant is not registered separately.

Length: 2–35
Examplecs

Response schema

1 status code documented

200SuccessPaginated list of unlock/lock history records.
itemsobject[]Required

Array of unlock/lock records.

Each array item:

Single unlock/lock history record.

idnumberRequired

TTLock record ID.

successbooleanRequired

Whether the unlock/lock action was successful.

lockDateDate | string | string | numberOptional

Timestamp of the action from the lock device.

One of 4:
Variant 1
Date

Timestamp of the action from the lock device.

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

Timestamp of the action from the TTLock server.

One of 4:
Variant 1
Date

Timestamp of the action from the TTLock server.

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

Translated record type label (e.g. "Unlock via app").

recordTypeFromLockstringRequired

Translated record type from the lock hardware.

keyboardPasswordstringOptional

Keyboard password used for the action (if applicable).

insertedDateDate | string | string | numberRequired

Date when the record was stored locally.

One of 4:
Variant 1
Date

Date when the record was stored locally.

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

Total number of records for pagination.

Response example

application/json
{
  "items": [
    {
      "id": 0,
      "success": false,
      "recordType": "example_recordType",
      "recordTypeFromLock": "example_recordTypeFromLock",
      "keyboardPassword": "example_keyboardPassword"
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/iot-lock/unlock-record-list

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