Skip to content

Stop Timer

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

Stop a timer → a finished range Event (occurred_at=start, duration=end-start), and delete the timer. ended_at defaults to now; it must be after the start and not in the future.

user_id
required
User Id
string format: uuid
timer_id
required
Timer Id
string format: uuid
Media typeapplication/json
TrackingTimerStop

Stop a running timer → a finished range Event. ended_at defaults to now; must be after the timer’s start and not in the future (validated server-side).

object
ended_at
Any of:
string format: date-time
label
Any of:
string
note
Any of:
string
Examplegenerated
{
"ended_at": "2026-04-15T12:00:00Z",
"label": "example",
"note": "example"
}

Successful Response

Media typeapplication/json
EventRead
object
boolean_value
required
Any of:
boolean
category_id
required
Any of:
string format: uuid
created_at
required
Created At
string format: date-time
duration
required
Any of:
string format: duration
id
required
Id
string format: uuid
label
required
Any of:
string
metadata
required
Metadata
object
key
additional properties
any
notes
required
Any of:
string
occurred_at
required
Occurred At
string format: date-time
saved_meal_id
required
Any of:
string format: uuid
scalar_value
required
Any of:
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
source
required
EventSource
string
Allowed values: user system
tags
required
Any of:
Array<string>
updated_at
required
Updated At
string format: date-time
user_id
required
User Id
string format: uuid
Example
{
"source": "user"
}

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"
}
]
}