Skip to content

Start Timer

POST
/users/{user_id}/tracking-timers
curl --request POST \
--url https://example.com/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/tracking-timers \
--header 'Content-Type: application/json' \
--data '{ "category_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "label": "example", "started_at": "2026-04-15T12:00:00Z" }'

Start a timer for an activity category or a free-text label.

user_id
required
User Id
string format: uuid
Media typeapplication/json
TrackingTimerStart

Start a timer for a category activity or a free-text label (at least one required).

object
category_id
Any of:
string format: uuid
label
Any of:
string
started_at
Any of:
string format: date-time
Examplegenerated
{
"category_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"label": "example",
"started_at": "2026-04-15T12:00:00Z"
}

Successful Response

Media typeapplication/json
TrackingTimerRead
object
category_id
required
Any of:
string format: uuid
created_at
required
Created At
string format: date-time
id
required
Id
string format: uuid
label
required
Any of:
string
started_at
required
Started At
string format: date-time
updated_at
required
Updated At
string format: date-time
user_id
required
User Id
string format: uuid
Examplegenerated
{
"category_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"created_at": "2026-04-15T12:00:00Z",
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"label": "example",
"started_at": "2026-04-15T12:00:00Z",
"updated_at": "2026-04-15T12:00:00Z",
"user_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}