Skip to main content
GET
Retrieve family settings

Authorizations

X-Api-Key
string
header
required

API key for authentication. Generate one from your account settings.

Response

family settings retrieved

id
string<uuid>
required
currency
string
required
locale
string
required
date_format
string
required
month_start_day
integer
required
Required range: 1 <= x <= 28
moniker
enum<string>
required
Available options:
Family,
Group
default_account_sharing
enum<string>
required
Available options:
shared,
private
custom_enabled_currencies
boolean
required
enabled_currencies
string[]
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
name
string | null
country
string | null
timezone
string | null