Sign in
User Account

Get user account data

Changed on

Retrieves the authenticated user's account information including email, name, language and currency preferences, the showUnassessedOrSensitiveContent preference, the user's subscription tier, and the user's role. Requires valid Cognito JWT authentication.

get/api/v1/me/account

Request

  • Base URL: https://api.stage.aura-historia.com
  • URL: https://api.stage.aura-historia.com/api/v1/me/account
  • Auth: HTTP bearer

Response

User account data retrieved successfully

userIdstring required

Unique identifier for the user.

emailstring email required

User's email address.

firstNamestring nullable
lastNamestring nullable
language'de' | 'en' | 'fr' | 'es' | 'it' | 'zh' | 'pt' | 'pl' | 'tr' | 'nl' | 'cs' | 'ja' | 'ru' | 'ar'

Supported language codes (ISO 639-1 canonical values):

  • de: German (includes de-DE, de-AT, de-CH, de-LU, de-LI)
  • en: English (includes en-US, en-GB, en-AU, en-CA, en-NZ, and backend-specific accepted alias en_IE)
  • fr: French (includes fr-FR, fr-CA, fr-BE, fr-CH, fr-LU)
  • es: Spanish (includes es-ES, es-MX, es-AR, es-CO, es-CL, es-PE, es-VE)
  • it: Italian (includes it-IT, it-CH)
  • zh: Chinese (Simplified) (includes zh-CN, zh-Hans)
  • pt: Portuguese (includes pt-PT, pt-BR)
  • pl: Polish (includes pl-PL)
  • tr: Turkish (includes tr-TR)
  • nl: Dutch (includes nl-NL, nl-BE)
  • cs: Czech (includes cs-CZ)
  • ja: Japanese (includes ja-JP)
  • ru: Russian (includes ru-RU)
  • ar: Arabic (includes ar-SA, ar-EG, ar-AE)

de, en, fr, es, and it are fully supported localization/translation-target languages. zh, pt, pl, tr, nl, cs, ja, ru, and ar are ingestion-only languages: they can appear in stored/native content and are accepted anywhere LanguageData is used, but backend-generated translations and fallback localized strings are not produced in these languages.

currency'EUR' | 'GBP' | 'USD' | 'AUD' | 'CAD' | 'NZD' | 'CNY' | 'BRL' | 'PLN' | 'TRY' | 'JPY' | 'CZK' | 'RUB' | 'AED' | 'SAR' | 'HKD' | 'SGD' | 'CHF' | 'ZAR' | 'SEK' | 'DKK' | 'NOK' | 'KRW' | 'INR' | 'TWD' | 'HUF' | 'RON' | 'MXN' | 'THB'

Supported currencies (ISO 4217 codes):

  • EUR: Euro
  • GBP: British Pound
  • USD: US Dollar
  • AUD: Australian Dollar
  • CAD: Canadian Dollar
  • NZD: New Zealand Dollar
  • CNY: Chinese Yuan
  • BRL: Brazilian Real
  • PLN: Polish Złoty
  • TRY: Turkish Lira
  • JPY: Japanese Yen
  • CZK: Czech Koruna
  • RUB: Russian Ruble
  • AED: UAE Dirham
  • SAR: Saudi Riyal
  • HKD: Hong Kong Dollar
  • SGD: Singapore Dollar
  • CHF: Swiss Franc
  • ZAR: South African Rand
  • SEK: Swedish Krona
  • DKK: Danish Krone
  • NOK: Norwegian Krone
  • KRW: South Korean Won
  • INR: Indian Rupee
  • TWD: New Taiwan Dollar
  • HUF: Hungarian Forint
  • RON: Romanian Leu
  • MXN: Mexican Peso
  • THB: Thai Baht
measurementUnit'METRIC' | 'IMPERIAL'

User preference for distance/size presentation:

  • METRIC: Metric units.
  • IMPERIAL: Imperial units.
showUnassessedOrSensitiveContentboolean required

Stored preference for showing unassessed or sensitive content.

marketingEmailConsentboolean required

Whether the current account email has an active grant for email marketing.

tier'FREE' | 'PRO' | 'ULTIMATE' required

The user's subscription tier, which determines limits and feature access (e.g. max watchlist entries, max search filters, allowed search filter fields).

  • FREE: Default tier for all users. Allows up to 20 watchlist entries, up to 1 search filter (limited to productQuery, price, state, excludeProductId, and lifecycle filter fields), and up to 10 product matches per filter.
  • PRO: Premium tier. Allows up to 100 watchlist entries, up to 5 search filters with access to all filter fields, and unlimited product matches per filter.
  • ULTIMATE: Highest tier. Allows unlimited watchlist entries, unlimited search filters with access to all filter fields, and unlimited product matches per filter.
role'USER' | 'ADMIN' required

The user's role used for API authorization.

  • USER: Standard authenticated user.
  • ADMIN: Administrator with access to admin-only endpoints.
stripeCustomerIdstring nullable

Persisted Stripe customer identifier, omitted when absent.

Example response

{
  "language": "de",
  "currency": "EUR",
  "measurementUnit": "METRIC",
  "tier": "FREE",
  "role": "USER"
}

Changes

  • ba3dfa02ef63Revision changes
    • warning

      added the new DKK enum value to the //// response property for the response status

    • warning

      added the new HUF enum value to the //// response property for the response status

    • warning

      added the new INR enum value to the //// response property for the response status

    • warning

      added the new KRW enum value to the //// response property for the response status

    • warning

      added the new MXN enum value to the //// response property for the response status

    • warning

      added the new NOK enum value to the //// response property for the response status

    • warning

      added the new RON enum value to the //// response property for the response status

    • warning

      added the new SEK enum value to the //// response property for the response status

    • warning

      added the new THB enum value to the //// response property for the response status

    • warning

      added the new TWD enum value to the //// response property for the response status

    • warning

      added the new ZAR enum value to the //// response property for the response status

    • info

      added the required property to the response with the status

  • 359a94242783Revision changes
    • info

      added the required property to the response with the status