List lock sessions
Returns all lock sessions you have access to (past and present) with their segment history, ordered by most recent first. Includes sessions owned by linked users — e.g. a lockee you keyhold for — alongside your own; use ownerId to distinguish owners.
Authorizations
AuthorizationstringheaderrequiredAPI tokens can be created in the Dashboard settings. Requires an Ultra subscription.
Query Parameters
limitintegerqueryNumber of records to return (default 50, max 100)
Required range: 1 ≤ x ≤ 100
Default: 50
Example: 50
offsetintegerqueryNumber of records to skip (default 0)
Required range: x ≥ 0
Default: 0
Example: 0
Response
200application/jsonList of lock sessions
List of lock sessions
okbooleanrequireddataobjectrequiredShow child attributes
datavalue[]requiredShow 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
paginationobjectrequiredShow child attributes
limitintegerrequiredNumber of records returned
Example: 50
offsetintegerrequiredNumber of records skipped
Example: 0
401application/jsonAuthentication required or token invalid
Authentication required or token invalid
okbooleanrequirederrorstringrequired500application/jsonInternal server error
Internal server error
okbooleanrequirederrorstringrequired