Deskhero Developer Hub
Back to deskhero.com
Tickets

Get locks

Lists every ticket lock currently held in the workspace: which tickets are being worked on, by which User and for how much longer the lock lasts unless refreshed. Locks live in Redis with a five minute expiry (no database writes) and are pushed to all connected Users over the websocket (SERVER_TICKET_LOCK_CHANGED) as they change, so this is the snapshot to load once and keep in sync from those events.

GET /api/{tenant:minlength(2)}/v{version:apiVersion}/tickets/locks
Authorisation
Minimum role: USER

Request arguments

Name Type Source
Request body example
No input arguments

Response

Status
200 (OK)
Type
DTO_ticket_lock[]
Wrapper
DTO_response_wrap
Other statuses
401 (Unauthorized), 403 (Forbidden), 429 (TooManyRequests)
Response body example
DTO_ticket_lock
NameTypeReadOnlyDescription
ticket_idInt32The ticket the lock belongs to
is_lockedBooleanTrue while a User holds the ticket. False means the ticket is free and the remaining properties are empty
user_idInt32The User holding the lock, default when the ticket is free
user_nameStringDisplay name of the User holding the lock, for the "locked by" indicator
locked_atDateTime (nullable)When the lock was first taken (UTC). Refreshing the lock keeps this
expires_in_secondsInt32Seconds until the lock expires on its own unless the holder edits the ticket or refreshes it again. 0 when the ticket is free

Generated Aug 22, 2026 09:36