Get active lock session
Returns the currently active lock session, including segment history. Returns null in the data field if no session is active. By default reads your own session; pass targetUserId to read the active session of a user you have access to — e.g. a keyholder checking the lockee's lock.
Authorizations
AuthorizationstringheaderrequiredAPI tokens can be created in the Dashboard settings. Requires an Ultra subscription.
Query Parameters
targetUserIdintegerqueryRead another user's active session instead of your own. The target must be a user you have access to; otherwise the request fails with 403.
Response
200application/jsonActive lock session or null
Active lock session or null
okbooleanrequireddatavaluerequiredShow child attributes
idintegerSession ID
bubbleIdstringUnique public identifier
publicIdstringPublic session ID
ownerIdintegerOwner user ID
namestringSession name
lockStateenumCurrent lock state
Allowed values: pendinglockedcompletedabandonedbreak
durationintegerLock duration in seconds
startDatestring<date-time> | nullSession start time
endDatestring<date-time> | nullSession end time
isActivebooleanWhether 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
idintegertypestringSegment type (start, locked, break, unlocked)
createdAtstring<date-time>isLockedbooleanLock state during segment
400application/jsonInvalid targetUserId
Invalid targetUserId
okbooleanrequirederrorstringrequired401application/jsonAuthentication required or token invalid
Authentication required or token invalid
okbooleanrequirederrorstringrequired403application/jsonTarget user not accessible
Target user not accessible
okbooleanrequirederrorstringrequired404application/jsonUser not found
User not found
okbooleanrequirederrorstringrequired