/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

1 total

Query · 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

Request

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"

Response

JSON payload

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

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key