Path parameters

• uuid string Required

Responses

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

  • uuid string
  • name string
  • has_alternative_branding boolean
  • brand_colours array
  • members_count integer
  • members array[object]
    Hide members attributes Show members 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 object
      Hide firm attributes Show firm attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        Name of the firm

      • slug

        Slug of the firm

      • address_1

        First line of the address

      • address_2

        Second line of the address

      • town_city

        Town/City

      • county

        County

      • postcode

        Postcode

      • country

        Country

      • regulatory_text

        Regulatory text of the firm.

      • logo

        URL of your firm logo.

      • logo_icon

        URL of your firm logo icon.

      • brand_colours

        Firm branding colours.

      • is_subscribed

        Subscription status.

      • keep_deleted_files_for

        Number of days to keep deleted files for

      • tax

        Tax percent

      • month_end

        Date of the month for the monthly income reconciliation statements to end

      • statement_frequency

        The frequency of the income reconciliation statements

      • billing

        Firm invoice details for billing

      • ip_whitelist

        A list of IP Addresses a firm is allowed to log in from.

      • welcome_paragraph_html

        Custom welcome paragraph html for the branded auth welcome page

      • email_welcome_paragraph_html

        Custom welcome paragraph for the welcome/new user email

      • show_fact_find_illustrations

        Determines if the illustrations/graphics are displayed on the fact find.

      • cc_email_addresses

        Array of email cc addresses.

      • bcc_email_addresses

        Array of email bcc addresses.

      • reply_to_email_address

        Firm reply to email address.

      • mobile_app_support_number

        Firm mobile app support number.

      • mobile_app_support_email

        Firm mobile app support email address.

    • primary_phone_number object
      Hide primary_phone_number attributes Show primary_phone_number attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Contact detail type

      • name

        Contact detail description

      • value

        Contact detail value

      • phone_number_meta

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

    • primary_email object
      Hide primary_email attributes Show primary_email attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Contact detail type

      • name

        Contact detail description

      • value

        Contact detail value

      • phone_number_meta

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

    • current_time_entry object
      Hide current_time_entry attributes Show current_time_entry attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        The name of the time entry.

      • description

        The description of the time entry.

      • trackable_type

        The model type that is being tracked. The example given is a client, but it can be a case, firm, circle or task.

      • start_date

        The start time of the time entry.

      • end_date

        The end time of the time entry.

      • is_active

        Determines if the time entry is currently ongoing.

      • total_time_in_minutes

        Total time in minutes.

      • computed_time_elapsed_in_seconds

        Computed time elapsed in seconds.

    • assigned_adviser object
      Hide assigned_adviser attributes Show assigned_adviser attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

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

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

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

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • assigned_administrator object
      Hide assigned_administrator attributes Show assigned_administrator attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

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

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

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

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • assigned_paraplanner object
      Hide assigned_paraplanner attributes Show assigned_paraplanner attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

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

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

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

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • introduced_by object
      Hide introduced_by attributes Show introduced_by attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

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

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

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

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • business_unit object
      Hide business_unit attributes Show business_unit attributes object

      • uuid

        The UUID of the resource.

      • name

        Name of the business unit.

      • has_alternative_branding

        Whether alternative branding is enabled for this business unit.

      • brand_colours

        Brand colours for this business unit, merged with firm defaults.

      • members_count

        Number of accounts assigned to this business unit

      • groups_count

        Number of groups assigned to this business unit

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

    • groups object
      Hide groups attributes Show groups attributes object

      • uuid

        UUID of the group

      • name

        Name of the group

      • slug

        Slug of the group

      • participants_count

        Number of participants in the group

      • participants

        Participants in this group

      • created_at

        Timestamp of when the group was created

      • updated_at

        Timestamp of when the group was updated

    • tags object
      Hide tags attributes Show tags attributes object

      • uuid

        UUID of the tag

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        The name of the tag

      • slug

        The slug of the tag

      • colour

        The colour of the tag

    • owners object
      Hide owners attributes Show owners attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        Account type

      • role

        Account role

      • first_name

        First name

      • last_name

        Last name

      • name

        Name

      • email

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

      • photo_url

        URL for initial avatar image

      • first_contact_date

        First contact date

      • next_review_date

        Next review date

      • previous_review_date

        Previous review date

      • anniversary_review_date

        Anniversary review date

      • terms_of_business_at

        Date the Terms of Business were agreed and signed

      • client_agreement_at

        Date the client agreement was agreed and signed

      • with_login

        Denotes whether the account has a login to Plannr

      • has_joint_account

        Denotes whether this account belongs to a joint account too

      • can_be_deleted

        Denotes if the account can be deleted

      • ownership_percentage

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

      • inactive_at

        Inactive from date

      • last_interaction_at

        Last interaction date

      • referral_code

        Unique referral code for the employee account (employees only)

      • permissions

        Permission map where keys are permission names and values are target arrays

    • first_contact_date string
    • next_review_date string
    • previous_review_date string
    • anniversary_review_date string
    • terms_of_business_at string
    • client_agreement_at string
    • with_login boolean
    • has_joint_account boolean
    • can_be_deleted string
    • joint_account_circle object
      Hide joint_account_circle attributes Show joint_account_circle attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        The Circle name

      • photo_url

        URL for initial avatar image

      • bg_colour

        Hex colour background for avatar

      • has_portal_access

        Whether any member of the circle has portal access

      • portal_access_status

        Aggregated portal access status: active, never_logged_in, or no_portal_access

      • engagement_rating

        Aggregated engagement rating: green, amber, red, or none

      • last_login

        Most recent portal login across all circle members, including who logged in

      • portal_login_count_30d

        Total portal login count across all members in last 30 days

      • portal_login_count_90d

        Total portal login count across all members in last 90 days

      • portal_login_count_365d

        Total portal login count across all members in last 365 days

      • joint_account_uuid

        uuid of joint account where circle created from joint account

      • login_access_level

        The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write

      • current_life_stage_uuid

        UUID of the circle's current life stage for expenditure

    • circles object
      Hide circles attributes Show circles attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • name

        The Circle name

      • photo_url

        URL for initial avatar image

      • bg_colour

        Hex colour background for avatar

      • has_portal_access

        Whether any member of the circle has portal access

      • portal_access_status

        Aggregated portal access status: active, never_logged_in, or no_portal_access

      • engagement_rating

        Aggregated engagement rating: green, amber, red, or none

      • last_login

        Most recent portal login across all circle members, including who logged in

      • portal_login_count_30d

        Total portal login count across all members in last 30 days

      • portal_login_count_90d

        Total portal login count across all members in last 90 days

      • portal_login_count_365d

        Total portal login count across all members in last 365 days

      • joint_account_uuid

        uuid of joint account where circle created from joint account

      • login_access_level

        The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write

      • current_life_stage_uuid

        UUID of the circle's current life stage for expenditure

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

      • uuid

        The UUID of the custom field

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • type

        The type of custom field

      • name

        The name of the custom field

      • reference

        The reference of the custom field, used when updating the custom field on the model.

      • is_required

        Denotes if the custom field is required

      • value

        The value of the custom field

      • selection_options

        This is the array of available options for the selection box. If the type is "selection" this array will be provided.

      • help_text

        Optional help text to aide the custom field. Will be displayed on Plannr.

    • external_references object
      Hide external_references attributes Show external_references attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • third_party

        The third party provider with the reference.

      • reference

        The third party reference.

  • groups_count integer
  • groups array[object]
    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
  • firm object
    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 object
      Hide addon_subscriptions attributes Show addon_subscriptions attributes object

      • uuid

        The UUID of the resource.

      • created_at

        The timestamp of when the resource was created.

      • updated_at

        The timestamp of when the resource was updated.

      • enabled

        Determines if the addon is enabled

      • trial_ends_at

        If the addon is a paid addon, this is the date the free trial will end for the addon subscription.

      • trial_ends_in_days

        If the addon is a paid addon, this is the number of days left in the free trial for the addon subscription.

      • payment_confirmed_at

        If the addon is a paid addon, this is the date the payment was confirmed for the addon subscription.

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

      • uuid

        uuid of the board

      • created_at

        timestamp of when the board was created

      • updated_at

        timestamp of when the board was updated

      • is_template

        returns true if the board is a template

      • name

        the name of the board

      • default_list_uuid

        the default list uuid

      • is_editable

        determines if the user can edit the board (e.g update the board, lists and move tasks around)

      • priorities

        returns the array of priorities that can be set within a task

    • ip_whitelist array[string]
    • welcome_paragraph_html string
    • email_welcome_paragraph_html string
    • show_fact_find_illustrations boolean
    • cc_email_addresses array[string]
    • bcc_email_addresses array[string]
    • reply_to_email_address string
    • mobile_app_support_number string
    • mobile_app_support_email string
  • created_at string
  • updated_at string