Get user settings

GET 
/v1/settings/overall

Get user settings

This endpoint retrieves a user's overall settings including currency preference, language setting, balance visibility option, and configured two-factor authentication methods. It requires a valid user ID and returns a JSON object containing these details if successful, or an internal server error message on failure.

Responses

200

User settings found

application/json

Schema

Schema

currency stringnullable
hideBalances booleanrequired
language stringnullable
twoFactorAuthentications object[]required
Array [
createdAt date-timerequired
id uuidrequired
name stringnullable
twoFaTypeId int32required
verified booleannullable
]

Example (from schema)

{
  "currency": "string",
  "hideBalances": true,
  "language": "string",
  "twoFactorAuthentications": [
    {
      "createdAt": "2024-09-25T19:42:12.628Z",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "twoFaTypeId": 0,
      "verified": true
    }
  ]
}

500

Internal server error

text/plain

Schema

Schema

string

Loading...