PaySuiteTT
Start free

Timer

Start a timer

View as Markdown

POSThttps://paysuitett.com/api/v1/timer/start

Starts a timer for the key's holder. Say where the time goes with one of the ways below.

Access. Any key; always its holder's own timer.

Body

A JSON object. Every field is optional.

task_idstring · uuid
File the time under this task. Takes precedence over the fields below.
project_idstring · uuid
The project, by ID. With `task` (a task name) or, for a project with one task, alone.
projectstring
The project, by its exact name (ignoring case). A name nobody has yet is added on the spot only when `client` is sent too, so a typo doesn't make a project.
clientstring
The client, by name. Only used with `project` to add a new project (and the client, if new).
taskstring
A task name in the project: found, or added if it doesn't exist. Not needed when the project has one task.
descriptionstring
What the work is, up to 2,000 characters.
billableboolean
Billable to the client. Defaults to true.
startstring · date-time
When it started, if not now. ISO 8601.
client_refstring · uuid
A UUID you choose. Sending the same one again returns the timer already started instead of starting another, so retries are safe.

Response

201 with a JSON body, as in the example.

  • A business allows one running timer per person unless it has changed that; starting another while one runs is refused with 400.