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.
- Mock serverhttps://developer.rosterfy.com/_mock/api-docs/openapi/api/v2/user/me
- Your Rosterfy accounthttps://example.rosterfy.com/api/v2/user/me
curl -i -X GET \
https://developer.rosterfy.com/_mock/api-docs/openapi/api/v2/user/me \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Rosterfy-Platform: admin'{ "user": { "id": 1234, "account_id": 20101, "email": "alex.example@example.com", "force_reset_password": 0, "password_expires_at": null, "first_name": "Alex", "middle_name": null, "last_name": "Example", "preferred_name": null, "phone": "au-200000000", "dob": "1990-01-15", "picture": null, "picture_status": 0, "is_subscribed": 0, "is_subscribed_transactional": 1, "is_unreachable": 0, "is_unreachable_sms": 0, "terms": 1, "rating": "0.00", "shift_privacy": 1, "is_team_leader": 0, "email_verified": 0, "login_lockout_attempts": 0, "login_lockout_at": null, "login_lockout_email_sent_at": null, "last_login_at": "2026-01-20T02:14:52.000000Z", "last_app_login_at": null, "is_archived": 0, "last_activated": null, "from_source": null, "delete_requested_at": null, "deleted_at": null, "is_erased": 0, "created_at": "2026-01-05T01:32:57.000000Z", "updated_at": "2026-01-20T01:42:50.000000Z", "deleted_by": null, "interests": null, "address": { … }, "rrn": "rrn:local:20101:user:AAAABBBBCCCCDDDDEEEEFFFF", "age": 36, "checkpoint_id": 3, "type_id": 2, "eula_agreed": false, "qr_code": "https://example.rosterfy.com/qr/qr-example.png" }, "nice": { "rrn": "rrn:local:20101:user:AAAABBBBCCCCDDDDEEEEFFFF", "family_id": null, "has_family_members": "No", "manages_family": false, "family_manager": "No", "family_member": "No", "is_family_member": false, "is_engaged": "No", "is_engaged:raw": false, "last_engaged_at": null, "last_engaged_at:raw": null, "created_at": "Jun 9, 2026, 5:33 AM", "created_at__date": "Jun 9, 2026", "created_at__time": "5:33 AM", "created_at__offset": " (+00:00 UTC)", "created_at__offset_minutes": 0, "created_at__dayofweek": "Tuesday", "email_verified": "No", "from_source": "", "interests": null, "interests:value": null, "interests:array": null, "is_subscribed_transactional": "Yes", "is_team_leader": "No", "last_login_at": "Aug 10, 2026, 5:16 AM", "last_login_at__date": "Aug 10, 2026", "last_login_at__time": "5:16 AM", "last_login_at__offset": " (+00:00 UTC)", "last_login_at__offset_minutes": 0, "last_login_at__dayofweek": "Monday", "middle_name": "", "picture_status": "N/A", "picture_status:value": 0, "picture_status:array": "N/A", "shift_privacy": "Yes", "updated_at": "Jun 9, 2026, 5:33 AM", "updated_at__date": "Jun 9, 2026", "updated_at__time": "5:33 AM", "updated_at__offset": " (+00:00 UTC)", "updated_at__offset_minutes": 0, "updated_at__dayofweek": "Tuesday", "first_name": "Alex", "last_name": "Example", "preferred_name": "", "dob": "Jan 15, 1990", "dob__dayofweek": "Monday", "is_subscribed": "No", "terms": "Yes", "name": "Alex Example", "age": 36, "age_months": "36 years, 0 months", "info": "Alex Example (alex.example@example.com)", "preferred_first_name": "Alex", "delete_requested": false, "updated_hours": 1487.7417004144, "is_community_user": false, "timezone": "UTC", "address": "1 Example Street\nExample City\nVictoria\nAustralia\n1000", "address_oneline": "1 Example Street, Example City, Victoria, Australia, 1000", "address.country": "Australia", "address.country:raw": "AUS", "phone": "(+61) 200000000", "phone:raw": "+61200000000" }, "type": { "id": 2, "account_branding_id": null, "name": "Default", "code": "default", "profile_form_id": null, "training_ids": null, "registration_form_id": null, "shift_limit": 0, "shift_max_time": null, "max_shift_length": 0, "min_shift_length": 0, "min_consecutive_rest_time_per_week": 0, "max_work_days_per_week": 0, "gap_between_shifts": 0, "group_leader_attributes": null, "deleted_at": null, "created_at": "2026-06-09T05:33:39.000000Z", "updated_at": "2026-06-09T05:33:39.000000Z", "uuid": "0cdefc27-b599-4a15-a82f-18c11bb44803" }, "permissions": { "admin": true, "event": true, "event:create": true, "event:read": true, "event:update": true, "event:delete": true, "user": true, "user:create": true, "user:read": true, "user:update": true, "user:delete": true, "training": true, "training:read": true, "report": true, "report:read": true }, "checkpoint": { "object": { … }, "nice": { … }, "relations": { … }, "permissions": { … } }, "checkpoint_permissions": { "training": true, "contact": true, "event": { … }, "blog": { … }, "rewardpoint": true, "inventory": true, "role_offer": { … }, "integration": { … }, "subaccount": true, "view_subaccount_selection_menu": true, "availability": true, "certificate": true, "eav": { … }, "user_group": true, "messaging": { … } }, "settings": { "general:locale": "en-AU", "general:timezone": "Australia/Melbourne", "general:advanced_pagination": false, "general:high_accessibility": false, "availability:advanced": false, "availability:available_by_default": true, "security:2fa": "" }, "socials": [], "is_primary_account": true, "has_account_roles": true, "messaging_user_id": null }