API reference
Settings
Profile settings.
Get settings
GET /api/v1/settings
Defaults (\{ profileName: "", gender: "female" }) for a user who never saved.
Responses
200— The settings. UserSettings401— Missing or invalid credential (session token or API key; only when auth is configured). Error
curl "$API_URL/api/v1/settings" \
-H "Authorization: Bearer $TOKEN"Save settings
PUT /api/v1/settings
Echoes the request body; reads back normalised to the three stored columns.
Request body (application/json)
Type: UserSettings
Responses
200— Saved.object401— Missing or invalid credential (session token or API key; only when auth is configured). Error
curl -X PUT "$API_URL/api/v1/settings" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ ... }'Schemas
UserSettings
Per-user profile settings.
| Field | Type | Required | Description |
|---|---|---|---|
profileName | string | yes | |
birthday | string | no | YYYY-MM-DD; absent (not null) when unset. |
gender | string | yes |
Error
| Field | Type | Required | Description |
|---|---|---|---|
error | string | yes |