← Back to schema index

UserMeBundle

Consolidated set for the authenticated user returned by `GET /v1/users/me`: profile, API key metadata, active subscription, two-factor authentication (2FA) state, role permissions and notification summary in a single call.

Properties

FieldTypeDescription
idstring (uuid)Unique user identifier (UUID v4).
emailstring (email)Email address tied to the user account: the one it signs in with and where its notifications arrive.
namestringName the user is presented with in the interface. Up to 100 characters.
rolestringThe user account's role in the organization. It decides what permissions its sessions carry — `owner`: It owns the account; `admin`: It administers it; `user`: It uses it.
statusstringAccount status. Only `active` allows API operations. `suspended`: Account suspended; `revoked`: Deleted by the user.
timezonestringIANA timezone the dates are presented to the user in.
languagestring | nullLanguage the user account prefers for the interface and the notifications — `es`: Spanish; `en`: English; `null`: The user account has not chosen a preferred language yet.
email_verified_atstring | nullDate and time when the email was verified, in ISO 8601 UTC. `null` when it is still pending.
created_atstring (date-time)Date and time when the account was created, in ISO 8601 UTC.
api_keyobject | nullThe user account's API key data. It never carries the full key: for that there is `POST /v1/users/me/api-key/reveal`, which requires the password.
prefixstringFirst 8 characters of the API key, which identify it without revealing it.
last_4string | nullLast 4 characters of the API key, used to render it masked (`example_a1b2••••••f9c2`). `null` for accounts predating that field, until it is backfilled.
subscriptionobject | nullThe user account's active subscription. When there is none, it carries the values of the system default plan, and it is `null` only when it could not be read — the case `_warnings` reports.
plan_slugstringUnique, human-readable plan identifier.
plan_namestring | nullDisplay name of the active plan, as the plan catalog shows it. It is `null` when the catalog could not be read.
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 | nullDate and time when the current billing period ends, in ISO 8601 UTC.
cancel_atstring | nullDate and time of the scheduled cancellation, in ISO 8601 UTC. `null` when none is pending.
billing_intervalstring | nullBilling cadence — `once`: One cycle with no automatic renewal; `month`: Monthly; `year`: Yearly.
two_factorobjectTwo-factor authentication (2FA) state.
enabledboolean`true` when two-factor authentication (2FA) is active on the user account.
methodstring | nullChannel the authentication code (OTP) is delivered through — `sms`: By text message; `email`: By email; `null`: The user account never configured it. Disabling 2FA keeps the last channel used.
last_used_atstring | nullDate and time of the last 2FA use, in ISO 8601 UTC. A field planned for later: today it is always `null`.
permissionsarrayFlat list of the user's role permissions in `resource:action` format.
notificationsobjectSummary of the user's notification queue.
unread_countintegerNumber of notifications that are neither read nor archived.
push_enabledboolean`true` when the account has at least one active push subscription.
telegram_linkedboolean`true` when the account has a linked Telegram chat.
legal_acceptedboolean`true` when no document is left pending: neither the Terms of Service nor the Privacy Notice. `false` when the acceptance of either is missing, or when the team required acceptance of a version that the account has not accepted yet. Gates the post-login consent modal, which lists what is pending in `GET /users/me/legal/pending`.
_warningsarrayPieces that could not be computed while assembling the response. It only appears when one failed, and the fields that depended on it arrive at their empty value (`null` or an empty list).

Used in operations

  • GET /v1/users/me