# Get current user

Returns everything a client needs about the signed-in user in a single call: who they are,
what they are allowed to do, and how their experience should be configured. This is the
call to make immediately after authenticating.
`user` is the profile itself, including any custom attributes the account has defined,
which appear as `custom_*` keys alongside the standard ones. `nice` is the same data
formatted for display - dates written out, phone numbers and addresses composed, coded
values resolved to their labels - so a client can render fields without reimplementing the
account's formatting rules. `type` is the user type they belong to, which carries the
shift limits and rules applied to them.
`permissions` states what the user may do, as a flat map of permission keys to booleans. It
is large for an administrator and short for an ordinary portal user, and the example below
shows a representative selection rather than the full set. Test for the specific keys you
care about rather than iterating the map, and treat an absent key as not granted.
`checkpoint` and `checkpoint_permissions` describe the onboarding stage the user has
reached and what that stage unlocks. `settings` holds their personal preferences, such as
locale and timezone, which should be preferred over any account default.
The remaining keys are small signals: `socials` lists the social accounts linked to the
profile, `is_primary_account` says whether they are signed in to the account that owns
their record rather than a related one, `has_account_roles` says whether they hold any
administrative role, and `messaging_user_id` is present only where messaging is enabled.
Because the response contains the caller's own personal data, treat it accordingly - do not
log it wholesale or cache it anywhere shared.

Endpoint: GET /api/v2/user/me
Version: 2.0.0
Security: default

## Header parameters:

  - `Rosterfy-Platform` (string)

## Response 200 fields (application/json):

  - `user` (object)

  - `user.id` (integer)

  - `user.account_id` (integer)

  - `user.email` (string)

  - `user.force_reset_password` (integer)

  - `user.password_expires_at` (string | null)

  - `user.first_name` (string)

  - `user.middle_name` (string | null)

  - `user.last_name` (string)

  - `user.preferred_name` (string | null)

  - `user.phone` (string)

  - `user.dob` (string)

  - `user.picture` (string | null)

  - `user.picture_status` (integer)

  - `user.is_subscribed` (integer)

  - `user.is_subscribed_transactional` (integer)

  - `user.is_unreachable` (integer)

  - `user.is_unreachable_sms` (integer)

  - `user.terms` (integer)

  - `user.rating` (string)

  - `user.shift_privacy` (integer)

  - `user.is_team_leader` (integer)

  - `user.email_verified` (integer)

  - `user.login_lockout_attempts` (integer)

  - `user.login_lockout_at` (string | null)

  - `user.login_lockout_email_sent_at` (string | null)

  - `user.last_login_at` (string)

  - `user.last_app_login_at` (string | null)

  - `user.is_archived` (integer)

  - `user.last_activated` (string | null)

  - `user.from_source` (string | null)

  - `user.delete_requested_at` (string | null)

  - `user.deleted_at` (string | null)

  - `user.is_erased` (integer)

  - `user.created_at` (string)

  - `user.updated_at` (string)

  - `user.deleted_by` (string | null)

  - `user.interests` (string | null)

  - `user.address` (object)

  - `user.address.iso` (string)

  - `user.address.region_code` (string)

  - `user.address.coordinates` (object)

  - `user.address.coordinates.latitude` (string | null)

  - `user.address.coordinates.longitude` (string | null)

  - `user.address.street_address_1` (string)

  - `user.address.street_address_2` (string | null)

  - `user.address.street_address_3` (string | null)

  - `user.address.city` (string)

  - `user.address.postcode` (string)

  - `user.address.region` (string)

  - `user.address.country` (string)

  - `user.address.latitude` (string | null)

  - `user.address.longitude` (string | null)

  - `user.rrn` (string)

  - `user.age` (integer)

  - `user.checkpoint_id` (integer)

  - `user.type_id` (integer)

  - `user.eula_agreed` (boolean)

  - `user.qr_code` (string)

  - `nice` (object)

  - `nice.rrn` (string)

  - `nice.family_id` (string | null)

  - `nice.has_family_members` (string)

  - `nice.manages_family` (boolean)

  - `nice.family_manager` (string)

  - `nice.family_member` (string)

  - `nice.is_family_member` (boolean)

  - `nice.is_engaged` (string)

  - `nice.is_engaged:raw` (boolean)

  - `nice.last_engaged_at` (string | null)

  - `nice.last_engaged_at:raw` (string | null)

  - `nice.created_at` (string)

  - `nice.created_at__date` (string)

  - `nice.created_at__time` (string)

  - `nice.created_at__offset` (string)

  - `nice.created_at__offset_minutes` (integer)

  - `nice.created_at__dayofweek` (string)

  - `nice.email_verified` (string)

  - `nice.from_source` (string)

  - `nice.interests` (string | null)

  - `nice.interests:value` (string | null)

  - `nice.interests:array` (string | null)

  - `nice.is_subscribed_transactional` (string)

  - `nice.is_team_leader` (string)

  - `nice.last_login_at` (string)

  - `nice.last_login_at__date` (string)

  - `nice.last_login_at__time` (string)

  - `nice.last_login_at__offset` (string)

  - `nice.last_login_at__offset_minutes` (integer)

  - `nice.last_login_at__dayofweek` (string)

  - `nice.middle_name` (string)

  - `nice.picture_status` (string)

  - `nice.picture_status:value` (integer)

  - `nice.picture_status:array` (string)

  - `nice.shift_privacy` (string)

  - `nice.updated_at` (string)

  - `nice.updated_at__date` (string)

  - `nice.updated_at__time` (string)

  - `nice.updated_at__offset` (string)

  - `nice.updated_at__offset_minutes` (integer)

  - `nice.updated_at__dayofweek` (string)

  - `nice.first_name` (string)

  - `nice.last_name` (string)

  - `nice.preferred_name` (string)

  - `nice.dob` (string)

  - `nice.dob__dayofweek` (string)

  - `nice.is_subscribed` (string)

  - `nice.terms` (string)

  - `nice.name` (string)

  - `nice.age` (integer)

  - `nice.age_months` (string)

  - `nice.info` (string)

  - `nice.preferred_first_name` (string)

  - `nice.delete_requested` (boolean)

  - `nice.updated_hours` (number)

  - `nice.is_community_user` (boolean)

  - `nice.timezone` (string)

  - `nice.address` (string)

  - `nice.address_oneline` (string)

  - `nice.address.country` (string)

  - `nice.address.country:raw` (string)

  - `nice.phone` (string)

  - `nice.phone:raw` (string)

  - `type` (object)

  - `type.id` (integer)

  - `type.account_branding_id` (string | null)

  - `type.name` (string)

  - `type.code` (string)

  - `type.profile_form_id` (string | null)

  - `type.training_ids` (string | null)

  - `type.registration_form_id` (string | null)

  - `type.shift_limit` (integer)

  - `type.shift_max_time` (string | null)

  - `type.max_shift_length` (integer)

  - `type.min_shift_length` (integer)

  - `type.min_consecutive_rest_time_per_week` (integer)

  - `type.max_work_days_per_week` (integer)

  - `type.gap_between_shifts` (integer)

  - `type.group_leader_attributes` (string | null)

  - `type.deleted_at` (string | null)

  - `type.created_at` (string)

  - `type.updated_at` (string)

  - `type.uuid` (string)

  - `permissions` (object)

  - `permissions.admin` (boolean)

  - `permissions.event` (boolean)

  - `permissions.event:create` (boolean)

  - `permissions.event:read` (boolean)

  - `permissions.event:update` (boolean)

  - `permissions.event:delete` (boolean)

  - `permissions.user` (boolean)

  - `permissions.user:create` (boolean)

  - `permissions.user:read` (boolean)

  - `permissions.user:update` (boolean)

  - `permissions.user:delete` (boolean)

  - `permissions.training` (boolean)

  - `permissions.training:read` (boolean)

  - `permissions.report` (boolean)

  - `permissions.report:read` (boolean)

  - `checkpoint` (object)

  - `checkpoint.object` (object)

  - `checkpoint.object.id` (integer)

  - `checkpoint.object.user_checkpoint_type_id` (string | null)

  - `checkpoint.object.name` (string)

  - `checkpoint.object.label` (string)

  - `checkpoint.object.permissions` (object)

  - `checkpoint.object.permissions.all` (string)

  - `checkpoint.object.actions` (array)

  - `checkpoint.object.is_inheritable` (integer)

  - `checkpoint.object.sort_order` (integer)

  - `checkpoint.object.deleted_at` (string | null)

  - `checkpoint.object.created_at` (string)

  - `checkpoint.object.updated_at` (string)

  - `checkpoint.nice` (object)

  - `checkpoint.nice.rrn` (string)

  - `checkpoint.nice.content_id` (integer)

  - `checkpoint.nice.account_name_path` (string)

  - `checkpoint.nice.is_foreign_account` (boolean)

  - `checkpoint.relations` (object)

  - `checkpoint.relations.user_checkpoint_type` (string | null)

  - `checkpoint.permissions` (object)

  - `checkpoint.permissions.read` (boolean)

  - `checkpoint.permissions.update` (boolean)

  - `checkpoint.permissions.delete` (boolean)

  - `checkpoint_permissions` (object)

  - `checkpoint_permissions.training` (boolean)

  - `checkpoint_permissions.contact` (boolean)

  - `checkpoint_permissions.event` (object)

  - `checkpoint_permissions.event.type` (boolean)

  - `checkpoint_permissions.event.apply_to_shifts` (boolean)

  - `checkpoint_permissions.event.calendar` (boolean)

  - `checkpoint_permissions.event.history` (boolean)

  - `checkpoint_permissions.event.has_enabled_shift_type` (boolean)

  - `checkpoint_permissions.event.shift_type` (boolean)

  - `checkpoint_permissions.event.activites` (boolean)

  - `checkpoint_permissions.event.use_leader_mode_when_not_checked_in` (boolean)

  - `checkpoint_permissions.event.shift_calendar` (boolean)

  - `checkpoint_permissions.blog` (object)

  - `checkpoint_permissions.blog.article` (boolean)

  - `checkpoint_permissions.rewardpoint` (boolean)

  - `checkpoint_permissions.inventory` (boolean)

  - `checkpoint_permissions.role_offer` (object)

  - `checkpoint_permissions.role_offer.apply` (boolean)

  - `checkpoint_permissions.role_offer.has_enabled_functional_area` (boolean)

  - `checkpoint_permissions.role_offer.functional_area` (boolean)

  - `checkpoint_permissions.integration` (object)

  - `checkpoint_permissions.integration.fundraising` (boolean)

  - `checkpoint_permissions.subaccount` (boolean)

  - `checkpoint_permissions.view_subaccount_selection_menu` (boolean)

  - `checkpoint_permissions.availability` (boolean)

  - `checkpoint_permissions.certificate` (boolean)

  - `checkpoint_permissions.eav` (object)

  - `checkpoint_permissions.eav.has_disabled_attributes` (boolean)

  - `checkpoint_permissions.eav.disabled_attributes` (boolean)

  - `checkpoint_permissions.user_group` (boolean)

  - `checkpoint_permissions.messaging` (object)

  - `checkpoint_permissions.messaging.access` (boolean)

  - `settings` (object)

  - `settings.general:locale` (string)

  - `settings.general:timezone` (string)

  - `settings.general:advanced_pagination` (boolean)

  - `settings.general:high_accessibility` (boolean)

  - `settings.availability:advanced` (boolean)

  - `settings.availability:available_by_default` (boolean)

  - `settings.security:2fa` (string)

  - `socials` (array)

  - `is_primary_account` (boolean)

  - `has_account_roles` (boolean)

  - `messaging_user_id` (string | null)