Get the authenticated user

GET /api/v1/me

Headers

Authorization string
Content-Type string
Accept string

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)
  
  Additional properties are allowed.
- current_login object
  
  The current account log in of the user (if included)
  
  Additional properties are allowed.
- 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.
  
  Additional properties are allowed.
- current_time_entry object
  
  The current time entry if a timer is running
  
  Additional properties are allowed.
- 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 \
 -X GET https://api.plannrcrm.com/api/v1/me \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json"

Response examples (200)

{
  "name": "Gareth Thompson",
  "type": "standard",
  "uuid": "01d56d9d-e97c-41a1-ad32-d2d45b3286e7",
  "email": "gareth@codepotato.co.uk",
  "last_name": "Thompson",
  "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
  "created_at": "2024-11-20T13:23:58+00:00",
  "first_name": "Gareth",
  "updated_at": "2024-11-20T13:23:58+00:00",
  "otp_pending": false,
  "current_login": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "uuid": "55412366-db3d-4cda-8383-c92c1c3dcfbb",
    "email": "gareth@plannrcrm.com",
    "account": "App\\Http\\Resources\\AccountResource",
    "primary": false,
    "last_name": "Thompson",
    "created_at": "2024-11-20T13:23:58+00:00",
    "expires_at": "2025-02-28T13:23:58+00:00",
    "first_name": "Gareth",
    "updated_at": "2024-11-20T13:23:58+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": "62fc763c-f7c6-4bac-adde-2351a4cba88d",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-11-20T13:23:58+00:00",
    "first_name": "Gareth",
    "updated_at": "2024-11-20T13:23:58+00:00",
    "with_login": true,
    "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": "2024-11-20T13:23:58+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-11-20T13:23:58+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-11-20T13:23:58+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-11-20T13:23:58+00:00"
  },
  "two_factor_type": "sms",
  "otp_confirmed_at": "2024-11-20T13:23:58+00:00",
  "two_factor_mobile": true,
  "current_time_entry": {
    "name": "Research",
    "uuid": "5eec212d-1eee-4ab1-b6cb-c59d2442212d",
    "end_date": "2024-11-20T13:23:58+00:00",
    "is_active": "1",
    "trackable": "Client",
    "start_date": "2024-11-20T13:23:58+00:00"
  },
  "session_expires_at": "2024-11-20T13:23:58+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"
  }
}