/bff/calendar/available-locks

Lightweight lock listing (id + alias + status) intended for the calendar-settings smart-lock selector. Returns every non-deleted lock in the authenticated organisation regardless of current binding — a single lock can be bound to more than one calendar. Use /bff/iot-lock/lock-list when the full health / gateway detail is needed.

CalendargetBffCalendarAvailable-locks

Parameters

No parameters required

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

Response schema

1 status code documented

200Success

itemsobject[]Required

Each array item:

lockIdnumberRequired

External TTLock identifier (matches /iot-lock/[lockId] and the update body).

aliasstringOptional

Display name of the lock. Empty aliases are omitted; the UI shows "Lock " as a fallback.

activebooleanRequired

Whether the lock is currently active in the system.

hasGatewaybooleanOptional

Whether the lock is connected to a Wi-Fi gateway. Unknown for locks that never reported.

Response example

application/json

{
  "items": [
    {
      "lockId": 0,
      "alias": "example_alias",
      "active": false,
      "hasGateway": false
    }
  ]
}

Request example

GET /bff/calendar/available-locks

get

curl -X GET "https://api.bizkithub.com/bff/calendar/available-locks" \
  -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