/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.

Endpoint Info

Base URLapi.bizkithub.com

AuthBearer Token

Methods1

Authentication Required

This endpoint requires a valid API key passed as a query parameter or Bearer token.

Get your API key

Parameters

1 query parameter

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

Example Request

JavaScript fetch

const response = await fetch("https://api.bizkithub.com/api/v1/lock/list?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE", {
  method: "GET",
  headers: {
    "Content-Type": "application/json"
  }
});

const data = await response.json();
console.log(data);

get

Example Response

200Success

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

cURL

Command line example

curl -X GET "https://api.bizkithub.com/api/v1/lock/list?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json"

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key

Back to API Documentation API Reference