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
    • last_interaction_at string
    • referral_code string
    • permissions object
      Hide permissions attributes Show permissions attributes object

      • firm:read array[string]
      • network:read array[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
    • user_type 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.

  • remember_token_expires_at boolean

    Denotes when the users "remember me" token expires.

  • 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.