GET /api/v1/me
Personal access token & O auth2

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • type string

      The user type

    • first_name string

      First name of the user

    • last_name string

      Last name of the user

    • name string

      Name of the user

    • email string

      Email of the user

    • photo_url string

      The photo URL of the user.

    • current_account object

      The current account log in of the user (if included)

      Hide current_account attributes Show current_account attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • firm string
      • primary_phone_number string
      • primary_email string
      • current_time_entry string
      • assigned_adviser string
      • assigned_administrator string
      • assigned_paraplanner string
      • introduced_by string
      • groups string
      • tags string
      • owners string
      • first_contact_date string
      • next_review_date string
      • previous_review_date string
      • anniversary_review_date string
      • with_login boolean
      • has_joint_account boolean
      • can_be_deleted string
      • joint_account_circle string
      • circles string
      • ownership_percentage integer
      • inactive_at string
      • custom_fields string
      • external_references string
    • current_login object

      The current account log in of the user (if included)

      Hide current_login attributes Show current_login attributes object
      • uuid string
      • created_at string
      • updated_at string
      • expires_at string
      • has_write_permission boolean
      • has_delete_permission boolean
      • primary boolean
      • receives_unread_notifications_email boolean
      • wealth_enabled boolean
      • goals_enabled boolean
      • factfind_enabled boolean
      • tasks_enabled boolean
      • welcome_enabled boolean
      • first_name string
      • last_name string
      • email string
      • account string
      • firm string
      • is_impersonated boolean
    • two_factor_enabled boolean

      Denotes if the two factor authentication has been enabled.

    • two_factor_type string

      The type of two factor enabled.

    • otp_confirmed_at string

      The date when OTP two factor was confirmed

    • otp_pending boolean

      Denotes if the OTP two factor is pending

    • sms_two_factor_enabled boolean

      Denotes if the SMS two factor is enabled

    • two_factor_mobile boolean

      The E.164 mobile phone used for two factor authentication.

    • two_factor_mobile_meta object

      If the two_factor_mobile is present, this additional field will be displayed giving you information about the phone number.

      Hide two_factor_mobile_meta attributes Show two_factor_mobile_meta attributes object
      • country string
      • formatted string
    • current_time_entry object

      The current time entry if a timer is running

      Hide current_time_entry attributes Show current_time_entry attributes object
      • uuid string
      • created_at string
      • updated_at string
      • name string
      • description string
      • trackable_type string
      • trackable string
      • start_date string
      • end_date string
      • is_active boolean
      • total_time_in_minutes integer
      • computed_time_elapsed_in_seconds integer
      • account string
    • session_expires_at string

      The session expiry time if signed in via the front-end.

    • should_auto_save_notes boolean

      Denotes if the user wants to use the auto-save notes feature. Can reduce browser performance on low-powered machines.
GET /api/v1/me 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/me' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "name": "Gareth Thompson",
  "type": "standard",
  "uuid": "9496dad5-54e3-43d6-91e4-51c27f4affa1",
  "email": "gareth@codepotato.co.uk",
  "last_name": "Thompson",
  "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
  "created_at": "2025-12-04T22:09:14+00:00",
  "first_name": "Gareth",
  "updated_at": "2025-12-04T22:09:14+00:00",
  "otp_pending": false,
  "current_login": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "uuid": "0d275f75-ebde-402d-aae0-8451eb76f6bb",
    "email": "gareth@plannrcrm.com",
    "account": "App\\Http\\Resources\\AccountResource",
    "primary": false,
    "last_name": "Thompson",
    "created_at": "2025-12-04T22:09:14+00:00",
    "expires_at": "2026-03-14T22:09:14+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-12-04T22:09:14+00:00",
    "goals_enabled": true,
    "tasks_enabled": true,
    "wealth_enabled": true,
    "is_impersonated": false,
    "welcome_enabled": true,
    "factfind_enabled": true,
    "has_write_permission": false,
    "has_delete_permission": false,
    "receives_unread_notifications_email": true
  },
  "current_account": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "d1bd68ee-6184-453c-91f8-14afa73ae798",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "created_at": "2025-12-04T22:09:14+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-12-04T22:09:14+00:00",
    "with_login": true,
    "inactive_at": "2025-12-04",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2025-12-04T22:09:14+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-12-04T22:09:14+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2025-12-04T22:09:14+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-12-04T22:09:14+00:00"
  },
  "two_factor_type": "sms",
  "otp_confirmed_at": "2025-12-04T22:09:14+00:00",
  "two_factor_mobile": true,
  "current_time_entry": {
    "name": "Research",
    "uuid": "d73f3585-ebf4-4194-9fbf-5fa85ce8a0d7",
    "account": "App\\Http\\Resources\\MinimalAccountResource",
    "end_date": "2025-12-04T21:47:14+00:00",
    "is_active": true,
    "trackable": "App\\Http\\Resources\\MinimalAccountResource",
    "created_at": "2025-12-04T22:09:14+00:00",
    "start_date": "2025-12-04T21:19:14+00:00",
    "updated_at": "2025-12-04T22:09:14+00:00",
    "description": "This is a description.",
    "trackable_type": "Client",
    "total_time_in_minutes": 28,
    "computed_time_elapsed_in_seconds": 1680
  },
  "session_expires_at": "2025-12-04T22:09:14+00:00",
  "two_factor_enabled": true,
  "should_auto_save_notes": true,
  "sms_two_factor_enabled": true,
  "two_factor_mobile_meta": {
    "country": "GB",
    "formatted": "0333 090 3630"
  }
}