/bff/branch/attachable-locks

Returns every lock in the organisation that is either unattached or already attached to THIS branch. Locks linked to a different branch are filtered out — the operator must detach them first.

BranchgetBffBranchAttachable-locks

Parameters

1 query

Query parameters

· 1

slugstringRequired

Branch slug — locks already attached to this branch are flagged.

Exampleexample_slug

Response schema

1 status code documented

200Success

itemsobject[]Required

Each array item:

lockIdnumberRequired

aliasstringOptional

electricQuantitynumberOptional

hasGatewaybooleanOptional

activebooleanRequired

attachedbooleanRequired

True if already attached to this branch.

Response example

application/json

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

Request example

GET /bff/branch/attachable-locks

get

curl -X GET "https://api.bizkithub.com/bff/branch/attachable-locks?slug=example_slug" \
  -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