Time Entries API
POST/api/v1/stopwatch
Product availabilityAlgaPSA

Start stopwatch

Starts a stopwatch session on a ticket or project task. A user has at most one open session: starting while one exists returns 409 with `details.open_session`. Also 409 when the ticket's board has the stopwatch turned off.

RBAC · time_entry

Request body

Content type: application/json · schema WorkV1StopwatchStartBody

work_item_typestringRequired
Enum: ticketproject_task
work_item_idstring <uuid>Required
service_idstring <uuid>Nullable
notesstring

Response body

Success response 201 · schema WorkV1StopwatchSessionResponse

dataobjectRequired
session_idstring <uuid>Required
user_idstring <uuid>Required
work_item_typestringRequired
work_item_idstring <uuid>RequiredNullable
service_idstring <uuid>RequiredNullable
notesstringRequired
statusstringRequired
Enum: runningpausedloggeddiscarded
time_entry_idstring <uuid>RequiredNullable
closed_atstring <date-time>RequiredNullable
created_atstring <date-time>Required
updated_atstring <date-time>Required
segmentsarray of objectRequired
itemsobject
segment_idstring <uuid>Required
started_atstring <date-time>Required
ended_atstring <date-time>RequiredNullable
Null while the segment is open (the stopwatch is running).
active_msnumberRequired
Active (non-paused) milliseconds as of server_now.
server_nowstring <date-time>Required
Server clock at the moment the response was built; derive a clock offset from it.
ticket_numberstringRequiredNullable
work_item_titlestringRequiredNullable
project_namestringRequiredNullable
client_namestringRequiredNullable
service_namestringRequiredNullable

Response codes

201
Session started.
400
Validation failure.
401
API key missing/invalid or associated user missing.
403
Permission denied (time_entry:create for mutations, time_entry:read for reads).
404
Work item not found.
409
An open session already exists (details.open_session) or the board disabled the stopwatch.
500
Unexpected failure.