← Back to schema index

UserMeBundle

Consolidated bundle for the authenticated user. Returned by GET /v1/users/me. Includes profile, API key metadata, active subscription, 2FA state, role permissions and notification summary in one roundtrip.

Properties

FieldTypeDescription
idstring (uuid)Unique user identifier (UUID v7).
emailstring (email)User email, used for login and notifications.
namestringUser's display name as shown in the dashboard.
rolestringUser's role in the organization. Determines available permissions. `owner` — account owner; `admin` — administers it; `user` — uses it; `viewer` — read-only.
statusstringAccount status. Only `active` allows API operations. `suspended` — account suspended; `pending_verification` — the email is still unverified.
timezonestringUser's IANA timezone, used to format timestamps in the UI.
languagestringUser's preferred language for UI and notifications. `es` for Spanish, `en` for English.
email_verified_atstring | nullISO 8601 UTC timestamp when the user verified their email. `null` if pending.
created_atstring (date-time)ISO 8601 UTC timestamp when the account was created.
api_keyobject | nullAPI key metadata. Never returns the full key (use POST /v1/users/me/api-key/reveal with password to reveal).
prefixstringAPI key prefix for visual identification. Does not include the full key.
last_4string | nullLast 4 characters of the API key for masked rendering (`example_a1b••••••f9c2`). `null` for accounts predating that field, until it is backfilled.
subscriptionobject | nullUser's active subscription. `null` if no active plan.
plan_slugstringIdentifier of the subscribed plan (free, pro, enterprise, etc.).
statusstringCurrent subscription status per the billing cycle. `active` — up to date; `trialing` — in trial; `past_due` — a charge is outstanding; `canceled` — cancelled; `paused` — paused.
current_period_endstring | nullEnd of the current billing period (ISO 8601 UTC).
cancel_atstring | nullScheduled cancellation date if the user initiated cancel-at-period-end. `null` if no cancellation is pending.
billing_intervalstring | nullBilling frequency of the subscribed plan. `month` bills monthly, `year` yearly, and `once` marks a one-off charge with no renewal.
two_factorobjectTwo-factor authentication state.
enabledboolean`true` if the user has 2FA enabled.
methodstring | nullOTP delivery channel. `null` if 2FA is disabled. `sms` sends the code by text message; `email`, by mail.
last_used_atstring | nullLast successful 2FA use. Future field, currently always `null`.
permissionsarrayFlat list of the user's role permissions in `resource:action` format.
notificationsobjectSummary of the user's notification queue.
unread_countintegerNumber of unread, non-archived notifications.
push_enabledboolean`true` if the user has at least one active push subscription.
telegram_linkedboolean`true` if the user has a linked Telegram chat.
_warningsarrayList of subsystems that failed while building this bundle. Only present when partial failures occurred. The fields corresponding to each failed subsystem will be at their default value (null or empty). Allows the client to degrade gracefully instead of going dark.

Used in operations

  • GET /v1/users/me