Get Me

GET

/api/v1/auth/me

const url = 'https://example.com/api/v1/auth/me';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/auth/me

Return current user’s profile for auth status check.

Responses

200

Successful Response

application/json

UserOut

Schema for user profile response — ORM serialization via from_attributes.

object

required

integer

sub

required

Sub

string

email

required

Any of:

string
null

string

name

required

Any of:

string
null

string

locale

Locale

string

default: fr

base_currency

Base Currency

string

default: EUR

theme

Theme

string

default: ledger

theme_mode

Theme Mode

string

default: light

date_format

Any of:

string
null

string

number_format

Any of:

string
null

string

font_size

Any of:

string
null

string

density

Any of:

string
null

string

report_frequency

Any of:

string
null

string

offer_rule_on_categorize

Offer Rule On Categorize

boolean

tour_seen

Tour Seen

boolean

setup_checklist_hidden

Setup Checklist Hidden

boolean

suggest_category_from_payee

Suggest Category From Payee

boolean

default: true

custom_css

Any of:

string
null

string

missing_rates_dismissed

Any of:

string
null

string

totp_enabled

Totp Enabled

boolean

is_admin

Is Admin

boolean

is_active

Is Active

boolean

default: true

Example

{
  "locale": "fr",
  "base_currency": "EUR",
  "theme": "ledger",
  "theme_mode": "light",
  "offer_rule_on_categorize": false,
  "tour_seen": false,
  "setup_checklist_hidden": false,
  "suggest_category_from_payee": true,
  "totp_enabled": false,
  "is_admin": false,
  "is_active": true
}