Lock Templates

Get active lock template

Returns the lock template used by the current active lock session. Returns null if no active lock.

GET

lkbx

templates

active

Authorizations

Authorizationstringheaderrequired

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

Response

200application/json

Active template or null

okbooleanrequired

datavalue

Show child attributes

idinteger

Template ID

ownerIdinteger

Owner user ID

namestring

Template name

durationinteger

Lock duration in seconds

isRandomDurationboolean

Whether duration is randomized

minDurationinteger | null

Minimum duration if random

maxDurationinteger | null

Maximum duration if random

isBreakEnabledboolean

Whether breaks are allowed

breakRegularityinteger

Break interval in seconds

breakMaximuminteger

Maximum break duration

breakPenaltyinteger

Penalty for exceeding break

breakKeyholderOnlyboolean

Only keyholder can grant breaks

isDeepthroatEnabledboolean

DTT integration enabled

deepthroatTimeReductioninteger

Time reduction per DTT session

isShameEnabledboolean

Shame feature enabled

shameTimeAddinteger

Time added for shame

isEmergencyUnlockEnabledboolean

Emergency unlock available

isPublicboolean

Whether publicly accessible

isPubliclyListedboolean

Whether listed publicly

isTestLockboolean

Whether this is a test lock

isTimeDisplayedboolean

Whether remaining time is shown

createdAtstring<date-time>

Creation timestamp

messagestring

Message when no active lock

401application/json

Authentication required or token invalid

okbooleanrequired

errorstringrequired

500application/json

Internal server error

okbooleanrequired

errorstringrequired