Lock Sessions

Get lock session by ID

Returns full details of a specific lock session, including the complete activity history (lock segments). Returns 404 if the session does not exist or belongs to a user you do not have access to.

GET

lkbx

session

{id}

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

idintegerpathrequired

The lock session ID

Required range: x ≥ 1

Example: 7

Response

200application/json

Lock session with segments

okbooleanrequired

datavaluerequired

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

400application/json

Invalid request parameters

okbooleanrequired

errorstringrequired

401application/json

Authentication required or token invalid

okbooleanrequired

errorstringrequired

404application/json

Lock session not found

okbooleanrequired

errorstringrequired