Lock Sessions

Get latest lock session

Returns the most recent lock session with all segment history. Returns null if no sessions exist.

GET

lkbx

sessions

latest

Authorizations

Authorizationstringheaderrequired

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

Response

200application/json

Latest session or null

okbooleanrequired

datavalue

Show child attributes

idinteger

Session ID

bubbleIdstring

Unique public identifier

publicIdstring

Public session ID

ownerIdinteger

Owner user ID

namestring

Session name

lockStateenum

Current lock state

Allowed values: pendinglockedcompletedabandonedbreak

durationinteger

Lock duration in seconds

startDatestring<date-time> | null

Session start time

endDatestring<date-time> | null

Session end time

isActiveboolean

Whether session is active

createdAtstring<date-time>

Creation timestamp

keyholderIdsinteger[]

IDs of the users assigned as keyholders for this session. An empty array means a self-lock (no keyholder). Resolve IDs to usernames via the Users endpoints.

LockSegmentobject[]

Show child attributes

idinteger

typestring

Segment type (start, locked, break, unlocked)

createdAtstring<date-time>

isLockedboolean

Lock state during segment

messagestring

Message when no sessions found

401application/json

Authentication required or token invalid

okbooleanrequired

errorstringrequired

500application/json

Internal server error

okbooleanrequired

errorstringrequired