LKBX

List lockbox devices

Report an API docs issue

Returns all Chastity Lockbox devices registered to your account, ordered by most recently visited.

GET
/
lkbx

Autorisations

Authorizationstringheaderrequired

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

Paramètres de requête

limitintegerquery

Number of records to return (default 50, max 100)

Required range: 1 ≤ x ≤ 100

Default: 50

Example: 50

offsetintegerquery

Number of records to skip (default 0)

Required range: x ≥ 0

Default: 0

Example: 0

Réponse

200application/json

List of lockbox devices

okbooleanrequired
dataobjectrequired
Show child attributes
dataobject[]required
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

paginationobjectrequired
Show child attributes
limitintegerrequired

Number of records returned

Example: 50

offsetintegerrequired

Number of records skipped

Example: 0

401application/json

Authentication required or token invalid

okbooleanrequired
errorstringrequired
500application/json

Internal server error

okbooleanrequired
errorstringrequired