Skip to content
IndepAI API Docs

Get User Settings

GET
/api/v1/user/settings

Get the authenticated user’s settings

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

User settings

object
success
required
boolean
data
required
object
userId
required

User ID

string format: uuid
Example
550e8400-e29b-41d4-a716-446655440000
preferredCurrency

Preferred display currency

string
default: EUR >= 3 characters <= 3 characters
Example
EUR
locale

Preferred locale for formatting

string
default: en-US
Example
en-US
timezone

Preferred timezone

string
default: Europe/Berlin
Example
Europe/Berlin
dateFormat

Preferred date format

string
default: YYYY-MM-DD
Allowed values: YYYY-MM-DD DD/MM/YYYY MM/DD/YYYY
Example
YYYY-MM-DD
notificationPreferences
required
object
email

Receive email notifications

boolean
default: true
push

Receive push notifications

boolean
weeklyReport

Receive weekly portfolio reports

boolean
default: true
marketAlerts

Receive market movement alerts

boolean
fiMilestones

Receive FI milestone notifications

boolean
default: true
privacySettings
required
object
showOnLeaderboard

Show profile on public leaderboard

boolean
sharePortfolioStats

Share anonymized portfolio stats

boolean
allowDataAnalytics

Allow usage analytics collection

boolean
default: true
fiSettings
required
object
targetWithdrawalRate

Target safe withdrawal rate (%)

number
default: 4 >= 1 <= 10
Example
4
expectedReturn

Expected annual return (%)

number
default: 7 >= -50 <= 50
Example
7
inflationRate

Expected inflation rate (%)

number
default: 2 <= 30
Example
2
retirementAge

Target retirement age

integer
>= 30 <= 100
Example
55
createdAt
required

Settings creation date

string format: date-time
Example
2024-01-15T10:30:00Z
updatedAt
required

Last settings update

string format: date-time
Example
2024-01-15T10:30:00Z
meta
required
object
timestamp
required

Timestamp in ISO 8601 format

string format: date-time
Example
2024-01-15T10:30:00Z

401

Section titled “401 ”

Unauthorized

object
success
required

Always false for error responses

boolean
error
required

Error type

string
Example
Validation error
code

Machine-readable error code

string
Example
VALIDATION_ERROR
details

Detailed validation errors

Array<object>
object
path
required

Path to the invalid field

string
Example
currentAge
message
required

Error message

string
Example
Must be between 18 and 100