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
| Field | Type | Description |
|---|---|---|
id | string (uuid) | Unique user identifier (UUID v4). |
email | string (email) | Email address tied to the user account: the one it signs in with and where its notifications arrive. |
name | string | Name the user is presented with in the interface. Up to 100 characters. |
role | string | The 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. |
status | string | Account status. Only `active` allows API operations. `suspended`: Account suspended; `revoked`: Deleted by the user. |
timezone | string | IANA timezone the dates are presented to the user in. |
language | string | null | Language 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_at | string | null | Date and time when the email was verified, in ISO 8601 UTC. `null` when it is still pending. |
created_at | string (date-time) | Date and time when the account was created, in ISO 8601 UTC. |
api_key | object | null | The 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. |
prefix | string | First 8 characters of the API key, which identify it without revealing it. |
last_4 | string | null | Last 4 characters of the API key, used to render it masked (`example_a1b2••••••f9c2`). `null` for accounts predating that field, until it is backfilled. |
subscription | object | null | The 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_slug | string | Unique, human-readable plan identifier. |
plan_name | string | null | Display name of the active plan, as the plan catalog shows it. It is `null` when the catalog could not be read. |
status | string | Current 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_end | string | null | Date and time when the current billing period ends, in ISO 8601 UTC. |
cancel_at | string | null | Date and time of the scheduled cancellation, in ISO 8601 UTC. `null` when none is pending. |
billing_interval | string | null | Billing cadence — `once`: One cycle with no automatic renewal; `month`: Monthly; `year`: Yearly. |
two_factor | object | Two-factor authentication (2FA) state. |
enabled | boolean | `true` when two-factor authentication (2FA) is active on the user account. |
method | string | null | Channel 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_at | string | null | Date and time of the last 2FA use, in ISO 8601 UTC. A field planned for later: today it is always `null`. |
permissions | array | Flat list of the user's role permissions in `resource:action` format. |
notifications | object | Summary of the user's notification queue. |
unread_count | integer | Number of notifications that are neither read nor archived. |
push_enabled | boolean | `true` when the account has at least one active push subscription. |
telegram_linked | boolean | `true` when the account has a linked Telegram chat. |
legal_accepted | boolean | `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`. |
_warnings | array | Pieces 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