Skip to main content
GET
/
api
/
v1
/
user
/
settings
Get user settings
curl --request GET \
  --url https://api.hevn.finance/api/v1/user/settings \
  --header 'Authorization: Bearer <token>'
{
  "appearance": "system",
  "devMode": false,
  "emailsTs": {},
  "notifications": {
    "cashFlow": {
      "email": true,
      "push": true
    },
    "suspiciousActivity": {
      "email": true,
      "push": true
    },
    "tasksAndApprovals": {
      "email": true,
      "push": true
    },
    "yourSpending": {
      "email": true,
      "push": true
    },
    "accountBalances": {
      "email": true,
      "push": true
    },
    "accounting": {
      "email": true,
      "push": true
    },
    "billPay": {
      "email": true,
      "push": true
    },
    "invoicing": {
      "email": true,
      "push": true
    },
    "collaboration": {
      "email": true,
      "push": true
    }
  },
  "bankRequested": {
    "rails": {
      "us": {
        "pooled": false,
        "named": false
      },
      "swift": {
        "pooled": false,
        "named": false
      },
      "eu": {
        "pooled": false,
        "named": false
      },
      "uae": {
        "pooled": false,
        "named": false
      }
    }
  }
}

Authorizations

​
Authorization
string
header
default:Bearer <token>
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-api-key
string | null

Response

Successful Response

User settings.

​
appearance
enum<string>
default:system

Appearance theme preference.

Available options:
system,
light,
dark
​
devMode
boolean
default:false
​
emailsTs
Emailsts · object
​
notifications
NotificationsSettings · object

User notification preferences grouped by category.

Categories are UI groupings over NotificationType. Mapping lives in NOTIFICATION_TYPE_CATEGORY. Defaults to all channels enabled.

​
bankRequested
BankRequestedSettings · object

User bank-rail interest settings.