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

/bff/iot-lock/password-list

Returns a paginated list of keyboard passcodes for a specific lock. Each passcode includes its validity period, active/deleted status, and linked calendar events (if the passcode was generated for a booking).

IoTgetBffIot-lockPassword-list

Parameters

1 query

Query parameters

· 1
idstringRequired

TTLock lock ID (from TTLock API).

Example12345

Response schema

1 status code documented

200SuccessPaginated list of keyboard passcodes.
itemsobject[]Required

Array of keyboard passcodes.

Each array item:

Single keyboard passcode item.

idnumberRequired

TTLock keyboard password ID.

activebooleanRequired

Whether the passcode is currently active (not deleted, within date range).

deletedbooleanRequired

Whether the passcode has been soft-deleted.

passwordstringOptional

The keyboard passcode digits.

eventListobject[]Required

Calendar events linked to this passcode.

Each array item:
titlestringRequired

Calendar event title.

calendarCodestringRequired

Calendar external code.

eventCodestringRequired

Calendar event external code.

startDateDate | string | string | numberOptional

Date when the passcode becomes active.

One of 4:
Variant 1
Date

Date when the passcode becomes active.

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

Date when the passcode expires.

One of 4:
Variant 1
Date

Date when the passcode expires.

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

Date when the passcode was sent to the lock.

One of 4:
Variant 1
Date

Date when the passcode was sent to the lock.

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

Date when the passcode was created in the system.

One of 4:
Variant 1
Date

Date when the passcode was created in the system.

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

Total number of passcodes for pagination.

Response example

application/json
{
  "items": [
    {
      "id": 0,
      "active": false,
      "deleted": false,
      "password": "example_password",
      "eventList": [
        {
          "title": "example_title",
          "calendarCode": "example_calendarCode",
          "eventCode": "example_eventCode"
        }
      ]
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/iot-lock/password-list

get
curl -X GET "https://api.bizkithub.com/bff/iot-lock/password-list?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