/api/v1/lock/list

Returns a simple list of all non-deleted TTLock smart locks for the organisation. Designed for mobile app usage — returns only essential fields needed for lock selection and status display.

IoTgetApiV1LockList

Parameters

1 query

Query parameters

· 1

apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE

Response schema

1 status code documented

200Success

itemsobject[]Required

Each array item:

lockIdstringRequired

TTLock lock ID (external identifier).

aliasstringRequired

Display name of the lock.

electricQuantitynumberOptional

Battery level percentage (0–100).

hasGatewaybooleanRequired

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

activebooleanRequired

Whether the lock is active in the system.

Response example

application/json

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

Request example

GET /api/v1/lock/list

get

curl -X GET "https://api.bizkithub.com/api/v1/lock/list?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -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