LKBX

Get lockbox device by ID

Report an API docs issue

Returns detailed information about a specific Chastity Lockbox device.

GET
/
lkbx
/
{id}

Autorisations

Authorizationstringheaderrequired

API tokens can be created in the Dashboard settings. Requires an Ultra subscription.

Paramètres de chemin

idintegerpathrequired

The lockbox device ID

Required range: x ≥ 1

Example: 1

Réponse

200application/json

Lockbox device details

okbooleanrequired
dataobjectrequired
Show child attributes
idinteger

Device ID

bubbleIdstring

Unique public identifier

macAddressstring

Device MAC address

ownerIdinteger

Owner user ID

lockedboolean

Current lock state

hueShiftinteger

LED color hue shift

lastVisitedstring<date-time>

Last connection time

lastLogAtstring<date-time>

Last log entry time

400application/json

Invalid request parameters

okbooleanrequired
errorstringrequired
401application/json

Authentication required or token invalid

okbooleanrequired
errorstringrequired
404application/json

Lockbox device not found

okbooleanrequired
errorstringrequired