Fahrtenbuch

Settings

Get personal settings

GET
/settings

Authorization

bearerAuth
headerAuthorizationBearer <JWT>

Response Body

Einstellungen

Example Request
curl -X GET 'https://example.com/api/v1/settings'
Example Response200
Empty

Update personal settings

PUT
/settings

Authorization

bearerAuth
headerAuthorizationBearer <JWT>

Request Body

application/json
  1. body
[key: string]?any

Response Body

Einstellungen aktualisiert

Example Request
curl -X PUT 'https://example.com/api/v1/settings' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response200
Empty

Get own profile settings

GET
/users/me/settings

Returns the signed-in user's profile and personal preferences, including distanceUnit (km or mi), dateFormat (EU or US), speedUnit (kmh or mph), and timeFormat (12h or 24h). Defaults are km, EU, kmh, and 24h.

Authorization

bearerAuth
headerAuthorizationBearer <JWT>

Response Body

User profile and settings

application/json
  1. response
user?
settings?

User preferences. Unspecified distanceUnit defaults to km.

Example Request
curl -X GET 'https://example.com/api/v1/users/me/settings'
Example Response
{  "user": {},  "settings": {    "mapStyle": "osm",    "distanceUnit": "km",    "dateFormat": "EU",    "speedUnit": "kmh",    "timeFormat": "12h",    "gravatarEnabled": true,    "gravatarAvailable": true,    "monthlyReportEnabled": true,    "monthlyReportAvailable": true,    "mapMatchingEnabled": true,    "mapMatchingAvailable": true,    "aiClassificationEnabled": false,    "aiClassificationAvailable": true,    "aiClassificationProvider": "claude"  }}
PATCH
/users/me/settings

Updates the signed-in user's personal preferences. Set distanceUnit to km or mi, dateFormat to EU or US, speedUnit to kmh or mph, and timeFormat to 12h or 24h. Stored trip distances, timestamps, and speeds are not modified.

Authorization

bearerAuth
headerAuthorizationBearer <JWT>

Request Body

application/json
  1. body
distanceUnit?string

Preferred display unit for distances.

Value in"km""mi"
dateFormat?string

Preferred date display format (EU DD.MM.YYYY; US MM/DD/YYYY).

Value in"EU""US"
speedUnit?string

Preferred speed display unit (km/h or mph).

Value in"kmh""mph"
timeFormat?string

Preferred clock format (12-hour AM/PM or 24-hour).

Value in"12h""24h"
mapStyle?string

Web map style – osm = the server's map default, light/dark = OpenFreeMap like in the Android app, auto = light or dark following the color scheme.

Value in"osm""light""dark""auto"

Response Body

Updated personal settings

application/json
  1. response

User preferences. Unspecified distanceUnit defaults to km.

mapStyle?string

Web map style – osm = the server's map default, light/dark = OpenFreeMap like in the Android app, auto = light or dark following the color scheme.

Default"osm"
Value in"osm""light""dark""auto"
distanceUnit?string

Preferred distance display unit. Stored trip distances remain in kilometers.

Default"km"
Value in"km""mi"
dateFormat?string

Preferred date display format. Does not change stored timestamps or API ISO dates.

Default"EU"
Value in"EU""US"
speedUnit?string

Preferred speed display unit (km/h or mph). Stored measurements are unchanged.

Default"kmh"
Value in"kmh""mph"
timeFormat?string

Preferred clock display format. Stored timestamps and API ISO dates are unchanged.

Default"24h"
Value in"12h""24h"
gravatarEnabled?boolean

Show the user's Gravatar (looked up by the hashed e-mail address) as profile picture in web and app. Can be changed via PATCH.

Defaulttrue
gravatarAvailable?boolean

False when the instance disables Gravatar (environment variable GRAVATAR_ENABLED=false); clients must not load Gravatar images then.

monthlyReportEnabled?boolean

Receive the monthly report by e-mail on the first of each month. Can be changed via PATCH.

Defaulttrue
monthlyReportAvailable?boolean

False when the server has no SMTP configuration; the monthly report is not sent then.

mapMatchingEnabled?boolean

Use map matching: trips are snapped to the road network automatically after upload (POST /tracking/stop, GPX import), and clients show the matched road route (GET /trips/{id}/matched-route) instead of the GPS line. When false, no automatic matching and clients show only the GPS route; distances already applied stay. Only takes effect while mapMatchingAvailable is true. Can be changed via PATCH.

Defaulttrue
mapMatchingAvailable?boolean

True when an administrator has set up a map matching service (Valhalla, OSRM or Dawarich Atlas).

aiClassificationEnabled?boolean

Let the AI provider suggest the trip type (business/private/commute). Opt-in, because addresses, times and recent classifications are sent to the provider. Can be changed via PATCH.

Defaultfalse
aiClassificationAvailable?boolean

True when the feature aiClassification is on and an administrator has set up an AI provider.

aiClassificationProvider?|

Active AI provider, shown so users know where their data goes.

Value in"claude""openai""ollama"null
[key: string]?any
Example Request
curl -X PATCH 'https://example.com/api/v1/users/me/settings' \  -H 'Content-Type: application/json' \  -d '{  "distanceUnit": "mi",  "dateFormat": "US",  "speedUnit": "mph",  "timeFormat": "12h"}'
Example Response
{  "mapStyle": "osm",  "distanceUnit": "km",  "dateFormat": "EU",  "speedUnit": "kmh",  "timeFormat": "12h",  "gravatarEnabled": true,  "gravatarAvailable": true,  "monthlyReportEnabled": true,  "monthlyReportAvailable": true,  "mapMatchingEnabled": true,  "mapMatchingAvailable": true,  "aiClassificationEnabled": false,  "aiClassificationAvailable": true,  "aiClassificationProvider": "claude"}