BizKitHub
DocsInteractive API Docs/api/v1/lock/unlock
post

/api/v1/lock/unlock

Sends an immediate remote unlock command to the specified lock via the TTLock API. The lock is identified by its TTLock lock ID (external identifier). Requires an active, non-deleted lock connected to a Wi-Fi gateway.

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

2 query parameters

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

lockIdstringrequired

TTLock lock ID (external identifier).

Example Request

JavaScript fetch

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

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

Example Response

200Success
{
  "success": false
}

cURL

Command line example

curl -X POST "https://api.bizkithub.com/api/v1/lock/unlock?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&lockId=12345" \
  -H "Content-Type: application/json"

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key
Back to API DocumentationAPI Reference