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
| Field | Type | Description |
|---|---|---|
id | string (uuid) | Unique user identifier (UUID v7). |
email | string (email) | User email, used for login and notifications. |
name | string | User's display name as shown in the dashboard. |
role | string | User's role in the organization. Determines available permissions. |
status | string | Account status. Only `active` allows API operations. |
timezone | string | User's IANA timezone, used to format timestamps in the UI. |
language | string | User's preferred language for UI and notifications. |
email_verified_at | string (date-time) | ISO 8601 UTC timestamp when the user verified their email. `null` if pending. |
created_at | string (date-time) | ISO 8601 UTC timestamp when the account was created. |
api_key | object | API key metadata. Never returns the full key (use POST /v1/users/me/api-key/reveal with password to reveal). |
prefix | string | API key prefix for visual identification. Does not include the full key. |
last_4 | string | Last 4 characters of the API key for masked rendering (`veriko_a1b••••••f9c2`). `null` for pre-v1.49 users until `bin/backfill-api-key-last-4.php` is run. |
subscription | object | User's active subscription. `null` if no active plan. |
plan_slug | string | Identifier of the subscribed plan (free, pro, enterprise, etc.). |
status | string | Current subscription status per the billing cycle. |
current_period_end | string (date-time) | End of the current billing period (ISO 8601 UTC). |
cancel_at | string (date-time) | Scheduled cancellation date if the user initiated cancel-at-period-end. `null` if no cancellation is pending. |
billing_interval | string | Billing frequency of the subscribed plan. |
two_factor | object | Two-factor authentication state. |
enabled | boolean | `true` if the user has 2FA enabled. |
method | string | OTP delivery channel. `null` if 2FA is disabled. |
last_used_at | string (date-time) | Last successful 2FA use. Future field, currently 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 unread, non-archived notifications. |
push_enabled | boolean | `true` if the user has at least one active push subscription. |
telegram_linked | boolean | `true` if the user has a linked Telegram chat. |
_warnings | array | List 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