Headers

• X-PLANNR-ACCOUNT-UUID string

Query parameters

• include string

  Comma separated list of relationships to include in the response. Valid relationships are [primary_phone_number,primary_email, assigned_adviser, assigned_administrator, groups, tags, owners, external_references].

• filter[uuid] string

  Filter by a comma separated list of UUIDs.

• filter[name] string

  Filter clients by name. This is a partial match against first_name, last_name, and entity_name together.

• filter[email] string

  Filter clients that have an email with a partial match.

• filter[is_prospect] boolean

  Get clients with this is_prospect value

• filter[status] string

  Filter client status by partial names or uuid's

• filter[type] string

  Comma separated string to filter by different client types. Valid types are [individual, joint, trust, business].

• filter[created_after] string

  Date to filter when the client was created after.

• filter[created_before] string

  Date to filter when the client was created before.

• filter[custom_field:REFERENCE] string

  Filter by a client custom field. Example filter[custom_field:pet_name]='Doug'

• filter[tags] string

  Comma separated list of tag names or tag UUIDs.

• filter[groups] string

  Comma separated list of partial groups names or group UUIDs.

• filter[exclude_groups] string

  Provide a group UUID (or multiple as a comma-separated string) to filter clients within the provided groups out from the response.

• filter[introduced_by] string

  Filter clients that have been introduced by this account.

• filter[linked_to] string

  Filter to clients that have been linked to the account given. This will also return the requested account.

• sort string

  Field to sort by. Valid fields are [created_at, updated_at, first_name, last_name, email, next_review_date, previous_review_date, anniversary_review_date]. Negative sign to denote DESC. Defaults to 'first_name'.

• per_page integer

  Number of results to return with pagination (Default 15. Max 500).

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

    Account type

  • role string

    Account role

  • first_name string

    First name

  • last_name string

    Last name

  • name string

    Name

  • email string

    (Deprecated - Please use primary_email instead). The email of the account.

  • photo_url string

    URL for initial avatar image

  • firm object

    Firm

    Hide firm attributes Show firm attributes object

    • uuid string
    • created_at string
    • updated_at string
    • name string
    • slug string
    • address_1 string
    • address_2 string
    • town_city string
    • county string
    • postcode string
    • country string
    • regulatory_text string
    • logo string
    • logo_icon string
    • brand_colours object
      Hide brand_colours attributes Show brand_colours attributes object

      • sidebar_background string
      • sidebar_accent string
      • sidebar_text string
      • sidebar_hover string
      • sidebar_active string
      • sidebar_title_background string
      • sidebar_title_primary string
      • sidebar_title_secondary string
      • sidebar_title_secondary_hover string
      • email_background string
      • email_logo_background_panel string
      • email_sub_text string
      • email_button_background string
      • email_button_text string
      • portal_sidebar_button_background string
      • portal_sidebar_button_hover string
      • portal_sidebar_button_active string
      • portal_brand_title string
      • portal_brand_sub_title string
      • portal_sidebar_title string
      • portal_sidebar_text string
      • portal_sidebar_text_hover string
      • portal_sidebar_text_active string
      • portal_sidebar_icon string
      • portal_sidebar_icon_hover string
      • portal_sidebar_icon_active string
      • portal_background string
      • portal_sidebar_account_title string
      • portal_sidebar_account_email string
      • portal_sidebar_divider string
      • portal_dashboard_bg_one string
      • portal_dashboard_bg_two string
      • portal_sidebar_collapse_button string
      • portal_sidebar_collapse_button_hover string
      • portal_sidebar_user_select_background string
      • portal_sidebar_user_select_hover string
      • portal_sidebar_user_select_text string
      • portal_sidebar_user_select_text_hover string
      • portal_sidebar_user_select_border string
      • portal_sidebar_user_select_border_hover string
    • is_subscribed boolean
    • addon_subscriptions string
    • keep_deleted_files_for integer
    • tax number
    • month_end integer
    • statement_frequency string
    • billing object
      Hide billing attributes Show billing attributes object

      • invoice_address_1 string
      • invoice_address_2 string
      • invoice_town_city string
      • invoice_county string
      • invoice_postcode string
      • invoice_country string
      • invoice_email string
    • task_board_template string
    • ip_whitelist array[string]
    • welcome_paragraph_html string
    • email_welcome_paragraph_html string
    • show_fact_find_illustrations boolean
  • primary_phone_number object

    Primary phone number

    Hide primary_phone_number attributes Show primary_phone_number attributes object

    • uuid string
    • created_at string
    • updated_at string
    • type string
    • name string
    • value string
    • phone_number_meta object
      Hide phone_number_meta attributes Show phone_number_meta attributes object

      • country string
      • formatted string
    • accounts string
  • primary_email object

    Primary email

    Hide primary_email attributes Show primary_email attributes object

    • uuid string
    • created_at string
    • updated_at string
    • type string
    • name string
    • value string
    • phone_number_meta object
      Hide phone_number_meta attributes Show phone_number_meta attributes object

      • country string
      • formatted string
    • accounts string
  • current_time_entry object

    Current time entry

    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
  • assigned_adviser object

    Assigned adviser

    Hide assigned_adviser attributes Show assigned_adviser 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
  • assigned_administrator object

    Assigned administrator

    Hide assigned_administrator attributes Show assigned_administrator 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
  • assigned_paraplanner object

    Assigned paraplanner

    Hide assigned_paraplanner attributes Show assigned_paraplanner 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
  • introduced_by object

    Introduced by

    Hide introduced_by attributes Show introduced_by 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
  • groups array[object]

    Groups

    Hide groups attributes Show groups attributes object

    • uuid string
    • name string
    • slug string
    • participants_count string
    • participants object
      Hide participants attributes Show participants attributes object

      • uuid object
        Hide uuid attributes Show uuid attributes object

        • example string
        • description string
      • role object
        Hide role attributes Show role attributes object

        • example string
        • description string
      • first_name object
        Hide first_name attributes Show first_name attributes object

        • example string
        • description string
      • last_name object
        Hide last_name attributes Show last_name attributes object

        • example string
        • description string
      • name object
        Hide name attributes Show name attributes object

        • example string
        • description string
      • email object
        Hide email attributes Show email attributes object

        • example string
        • description string
    • created_at string
    • updated_at string
  • tags array[object]

    Tags

    Hide tags attributes Show tags attributes object

    • uuid string
    • created_at string
    • updated_at string
    • name string
    • slug string
    • colour string
  • owners array[object]

    Accounts that own this account

    Hide owners attributes Show owners 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
  • first_contact_date string

    First contact date

  • next_review_date string

    Next review date

  • previous_review_date string

    Previous review date

  • anniversary_review_date string

    Anniversary review date

  • with_login boolean

    Denotes whether the account has a login to Plannr

  • has_joint_account boolean

    Denotes whether this account belongs to a joint account too

  • can_be_deleted string

    Denotes if the account can be deleted

  • joint_account_circle object

    This field is only present when viewing a joint account directly. This will contain the circle that we automatically created when we released circles.

    Hide joint_account_circle attributes Show joint_account_circle attributes object

    • uuid string
    • created_at string
    • updated_at string
    • name string
    • photo_url string
    • bg_colour string
    • accounts string
    • groups string
    • joint_account_uuid string
    • login_access_level string
    • external_references string
  • circles array[object]

    The circles the account belongs to

    Hide circles attributes Show circles attributes object

    • uuid string
    • created_at string
    • updated_at string
    • name string
    • photo_url string
    • bg_colour string
    • accounts string
    • groups string
    • joint_account_uuid string
    • login_access_level string
    • external_references string
  • ownership_percentage integer

    Percentage ownership of the plan (This field is only present if viewing the account record via a plans relationship eg Plan -> Accounts)

  • inactive_at string

    Inactive from date

  • custom_fields array[object]

    Any custom fields on the model.

    Hide custom_fields attributes Show custom_fields attributes object

    • uuid string
    • created_at string
    • updated_at string
    • type string
    • name string
    • reference string
    • is_required boolean
    • value string
    • selection_options array[string]
    • help_text string
  • external_references array[object]

    The external references that have been added to the client.

    Hide external_references attributes Show external_references attributes object

    • uuid string
    • created_at string
    • updated_at string
    • third_party string
    • reference string