Get All Reports Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}
Close
GET /api/v1/report
Personal access token & O auth2

Query parameters

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[report_type_id] string

    Exact filter for type of report to return

  • filter[created_by] string

    list of adviser uuids to filter reports created by these accounts

  • sort string

    Field to sort by. Valid fields are [updated_at, created_at, name, report_type_id]. Negative sign to denote DESC. Defaults to '-created_at'.

  • per_page integer

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

Responses

  • 200 application/json
    Hide response attribute Show response attribute object
    • data array[object]
      Hide data attributes Show data attributes object
      • uuid string
      • created_at string
      • updated_at string
      • last_interaction_at string
      • last_login_at string
      • name string
      • created_by object
        Hide created_by attributes Show created_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 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_icon

            URL of your firm logo icon.

          • brand_colours

            Firm branding colours.

          • factfind_pdf_header_background

            Header background colour (hex) for the fact-find snapshot PDF.

          • factfind_pdf_header_text

            Header text colour (hex) for the fact-find snapshot PDF.

          • 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

            IP addresses allowed to access the firm. Authorised Plannr-issued integrations are exempt.

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

          • is_out_of_office

            Denotes whether the account is currently within an active Out of Office window (employees only)

          • out_of_office_from

            Start of the Out of Office period (employees only). Null when not out of office

          • out_of_office_until

            End of the Out of Office period (employees only). Null when not out of office

          • out_of_office_message

            Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

          • is_pending_fact_find_account

            Denotes whether the account is a provisional account created by a fact find that has not yet been submitted (clients only)

          • permissions

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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

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

          • is_out_of_office

            Denotes whether the account is currently within an active Out of Office window (employees only)

          • out_of_office_from

            Start of the Out of Office period (employees only). Null when not out of office

          • out_of_office_until

            End of the Out of Office period (employees only). Null when not out of office

          • out_of_office_message

            Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

          • is_pending_fact_find_account

            Denotes whether the account is a provisional account created by a fact find that has not yet been submitted (clients only)

          • permissions

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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

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

          • is_out_of_office

            Denotes whether the account is currently within an active Out of Office window (employees only)

          • out_of_office_from

            Start of the Out of Office period (employees only). Null when not out of office

          • out_of_office_until

            End of the Out of Office period (employees only). Null when not out of office

          • out_of_office_message

            Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

          • is_pending_fact_find_account

            Denotes whether the account is a provisional account created by a fact find that has not yet been submitted (clients only)

          • permissions

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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

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

          • is_out_of_office

            Denotes whether the account is currently within an active Out of Office window (employees only)

          • out_of_office_from

            Start of the Out of Office period (employees only). Null when not out of office

          • out_of_office_until

            End of the Out of Office period (employees only). Null when not out of office

          • out_of_office_message

            Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

          • is_pending_fact_find_account

            Denotes whether the account is a provisional account created by a fact find that has not yet been submitted (clients only)

          • permissions

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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

        • 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

        • marketing_consent object
          Hide marketing_consent attributes Show marketing_consent attributes object
          • email

            Marketing consent status for email. One of not_captured, opted_in and opted_out

          • phone

            Marketing consent status for phone. One of not_captured, opted_in and opted_out

          • letter

            Marketing consent status for letter. One of not_captured, opted_in and opted_out

          • sms

            Marketing consent status for SMS. One of not_captured, opted_in and opted_out

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

          • is_out_of_office

            Denotes whether the account is currently within an active Out of Office window (employees only)

          • out_of_office_from

            Start of the Out of Office period (employees only). Null when not out of office

          • out_of_office_until

            End of the Out of Office period (employees only). Null when not out of office

          • out_of_office_message

            Message shown to portal users while the account is Out of Office (employees only). Null when not out of office

          • is_pending_fact_find_account

            Denotes whether the account is a provisional account created by a fact find that has not yet been submitted (clients only)

          • permissions

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

          • managed_by_head_office

            Whether head office set this employee's firm role from their enterprise role. The firm can add restrictions on top but cannot change or remove the role itself.

        • 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
        • is_out_of_office boolean
        • out_of_office_from string
        • out_of_office_until string
        • out_of_office_message string
        • service_level object
          Hide service_level attributes Show service_level attributes object
          • uuid

            The UUID of the resource.

          • name

            The name of the service level.

          • created_at

            The timestamp of when the resource was created.

          • updated_at

            The timestamp of when the resource was updated.

        • is_pending_fact_find_account boolean
        • permissions object
          Hide permissions attributes Show permissions attributes object
          • firm:read array[string]
          • network:read array[string]
        • managed_by_head_office boolean
        • 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.

      • report_type_id string
      • status string
      • progress integer
      • files array[object]
        Hide files attributes Show files attributes object
        • uuid string
        • created_at string
        • original_created_at string
        • updated_at string
        • uploaded_at string
        • status string
        • filename string
        • name string
        • extension string
        • type string
        • size string
        • path string
        • last_modified string
        • progress string
        • download_url string
        • preview_url string
        • folder_name string
        • folder object
          Hide folder attributes Show folder 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

            Folder name

          • slug

            Slug of the folder name

          • path

            Folder path

          • clients_read

            Denotes whether clients can access this folder and files

          • clients_write

            Denotes whether clients can upload files to this folder

          • show_client_permissions

            Denotes whether the option to change client permissions is enabled which depends on the firm show pseudo folders in client portal setting

          • is_system_folder

            Denotes if this folder is a system folder

          • is_pseudo_folder

            Denotes if this folder is a pseudo folder

          • is_root_folder

            Denotes if this folder is a root folder of a documentable item

          • documentable_type

            The documentable type such as account/plan/case/etc the file was uploaded to

          • documentable_uuid

            The UUID of the documentable resource

          • documentable

            The documentable the file was uploaded to

          • participants_count

            Number of accounts this folder has been directly shared with

          • folders_count

            Number of subfolders within the folder

          • files_count

            Number of files stored in the folder

          • depth

            How many levels deep there are to this folder hierarchy structure

          • owned

            Is true if the authenticated account in the request has created this folder

        • documentable_type string
        • documentable string
        • navigator object
          Hide navigator attributes Show navigator attributes object
          • model_type string
          • model_uuid 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_icon

            URL of your firm logo icon.

          • brand_colours

            Firm branding colours.

          • factfind_pdf_header_background

            Header background colour (hex) for the fact-find snapshot PDF.

          • factfind_pdf_header_text

            Header text colour (hex) for the fact-find snapshot PDF.

          • 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

            IP addresses allowed to access the firm. Authorised Plannr-issued integrations are exempt.

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

        • account object
          Hide account attributes Show account 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 the primary email of the account instead). The email of the account.

          • photo_url

            The photo URL of the client

        • 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

      • folder object
        Hide folder attributes Show folder attributes object
        • uuid string
        • created_at string
        • updated_at string
        • name string
        • slug string
        • path string
        • clients_read boolean
        • clients_write boolean
        • show_client_permissions boolean
        • is_system_folder boolean
        • is_pseudo_folder boolean
        • is_root_folder boolean
        • documentable_type string
        • documentable_uuid string
        • documentable string
        • participants_count integer
        • participants object
          Hide participants attributes Show participants 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 person the folder is shared with.

          • write

            Whether the participant has write access to this folder.

        • folders_count integer
        • folders object
          Hide folders attributes Show folders 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

            Folder name

          • slug

            Slug of the folder name

          • path

            Folder path

          • clients_read

            Denotes whether clients can access this folder and files

          • clients_write

            Denotes whether clients can upload files to this folder

          • show_client_permissions

            Denotes whether the option to change client permissions is enabled which depends on the firm show pseudo folders in client portal setting

          • is_system_folder

            Denotes if this folder is a system folder

          • is_pseudo_folder

            Denotes if this folder is a pseudo folder

          • is_root_folder

            Denotes if this folder is a root folder of a documentable item

          • documentable_type

            The documentable type such as account/plan/case/etc the file was uploaded to

          • documentable_uuid

            The UUID of the documentable resource

          • documentable

            The documentable the file was uploaded to

          • participants_count

            Number of accounts this folder has been directly shared with

          • folders_count

            Number of subfolders within the folder

          • files_count

            Number of files stored in the folder

          • depth

            How many levels deep there are to this folder hierarchy structure

          • owned

            Is true if the authenticated account in the request has created this folder

        • files_count integer
        • files object
          Hide files attributes Show files attributes object
          • uuid

            UUID of the file

          • created_at

            The timestamp of when the resource was created.

          • original_created_at

            Timestamp of when the file was originally created

          • updated_at

            The timestamp of when the resource was updated.

          • uploaded_at

            Timestamp of when the file was uploaded

          • status

            Current status of the uploading progress

          • filename

            The filename including extension

          • name

            The name of the file without extension

          • extension

            The extension of the file

          • type

            The MIME type of the file

          • size

            The size of the file in bytes

          • path

            The path of the file

          • last_modified

            Timestamp of when the file was last modified before uploading

          • progress

            The progress of the uploaded file as a percentage between 0 and 100

          • download_url

            The download URL of the file

          • preview_url

            The URL to preview the file inline in the browser. Only present for images and PDFs within the preview size limit

          • folder_name

            The name of the folder the file is located in

          • documentable_type

            The documentable type such as account/plan/case/etc the file was uploaded to

          • documentable

            The documentable the file was uploaded to

          • navigator

            The documentable type and its UUID in order to navigator to the correct resource

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

            Folder name

          • slug

            Slug of the folder name

          • path

            Folder path

          • clients_read

            Denotes whether clients can access this folder and files

          • clients_write

            Denotes whether clients can upload files to this folder

          • show_client_permissions

            Denotes whether the option to change client permissions is enabled which depends on the firm show pseudo folders in client portal setting

          • is_system_folder

            Denotes if this folder is a system folder

          • is_pseudo_folder

            Denotes if this folder is a pseudo folder

          • is_root_folder

            Denotes if this folder is a root folder of a documentable item

          • documentable_type

            The documentable type such as account/plan/case/etc the file was uploaded to

          • documentable_uuid

            The UUID of the documentable resource

          • documentable

            The documentable the file was uploaded to

          • participants_count

            Number of accounts this folder has been directly shared with

          • folders_count

            Number of subfolders within the folder

          • files_count

            Number of files stored in the folder

          • depth

            How many levels deep there are to this folder hierarchy structure

          • owned

            Is true if the authenticated account in the request has created this folder

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

            Folder name

          • slug

            Slug of the folder name

          • path

            Folder path

          • clients_read

            Denotes whether clients can access this folder and files

          • clients_write

            Denotes whether clients can upload files to this folder

          • show_client_permissions

            Denotes whether the option to change client permissions is enabled which depends on the firm show pseudo folders in client portal setting

          • is_system_folder

            Denotes if this folder is a system folder

          • is_pseudo_folder

            Denotes if this folder is a pseudo folder

          • is_root_folder

            Denotes if this folder is a root folder of a documentable item

          • documentable_type

            The documentable type such as account/plan/case/etc the file was uploaded to

          • documentable_uuid

            The UUID of the documentable resource

          • documentable

            The documentable the file was uploaded to

          • participants_count

            Number of accounts this folder has been directly shared with

          • folders_count

            Number of subfolders within the folder

          • files_count

            Number of files stored in the folder

          • depth

            How many levels deep there are to this folder hierarchy structure

          • owned

            Is true if the authenticated account in the request has created this folder

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

            Folder name

          • slug

            Slug of the folder name

          • path

            Folder path

          • clients_read

            Denotes whether clients can access this folder and files

          • clients_write

            Denotes whether clients can upload files to this folder

          • show_client_permissions

            Denotes whether the option to change client permissions is enabled which depends on the firm show pseudo folders in client portal setting

          • is_system_folder

            Denotes if this folder is a system folder

          • is_pseudo_folder

            Denotes if this folder is a pseudo folder

          • is_root_folder

            Denotes if this folder is a root folder of a documentable item

          • documentable_type

            The documentable type such as account/plan/case/etc the file was uploaded to

          • documentable_uuid

            The UUID of the documentable resource

          • documentable

            The documentable the file was uploaded to

          • participants_count

            Number of accounts this folder has been directly shared with

          • folders_count

            Number of subfolders within the folder

          • files_count

            Number of files stored in the folder

          • depth

            How many levels deep there are to this folder hierarchy structure

          • owned

            Is true if the authenticated account in the request has created this folder

        • depth integer
        • owned boolean
      • can_delete boolean
GET /api/v1/report 
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/report' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "data": [
    {
      "uuid": "7933ad87-79bc-46a8-98ff-f981aa160040",
      "created_at": "2026-10-27T15:44:14+00:00",
      "updated_at": "2026-10-27T15:44:14+00:00",
      "last_interaction_at": "2024-01-24T10:30:00Z",
      "last_login_at": "2024-01-24T09:15:00Z",
      "name": "rmar-report-2026-10-27T15:44:14+00:00",
      "created_by": {
        "uuid": "21fe9c86-3254-42c2-9f8e-7987d4277114",
        "created_at": "2026-10-27T15:44:14+00:00",
        "updated_at": "2026-10-27T15:44:14+00:00",
        "type": "client",
        "role": "client",
        "first_name": "Gareth",
        "last_name": "Thompson",
        "name": "Gareth Thompson",
        "email": "gareth@codepotato.co.uk",
        "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
        "firm": {
          "uuid": "c34e39d6-b8b3-47ab-a2e1-4989626570e4",
          "created_at": "2026-10-27T15:44:19+00:00",
          "updated_at": "2026-10-27T15:44:19+00:00",
          "name": "Codepotato",
          "slug": "codepotato",
          "address_1": "Suite E, 5 The Briars",
          "address_2": "Waterberry Drive",
          "town_city": "Waterlooville",
          "county": "Hampshire",
          "postcode": "PO7 7YH",
          "country": "United Kingdom",
          "regulatory_text": "Regulatory text",
          "logo": "https://api.plannrcrm.com/images/plannr.jpg",
          "logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
          "brand_colours": {
            "sidebar_background": "#0E0E56",
            "sidebar_accent": "#36367E",
            "sidebar_text": "#FFFFFF",
            "sidebar_hover": "#0A0A42",
            "sidebar_active": "#53DBB8",
            "sidebar_title_background": "#36367E",
            "sidebar_title_primary": "#FFC634",
            "sidebar_title_secondary": "#FFFFFF",
            "sidebar_title_secondary_hover": "#FFFFFF",
            "email_background": "#0E0E56",
            "email_logo_background_panel": "#36367E",
            "email_sub_text": "#FFFFFF",
            "email_button_background": "#36367E",
            "email_button_text": "#FFFFFF",
            "portal_sidebar_button_background": "#F6F6F6",
            "portal_sidebar_button_hover": "#FFFFFF",
            "portal_sidebar_button_active": "#FFFFFF",
            "portal_brand_title": "#323B4B",
            "portal_brand_sub_title": "#828994",
            "portal_sidebar_title": "#11151D",
            "portal_sidebar_text": "#323B4B",
            "portal_sidebar_text_hover": "#323B4B",
            "portal_sidebar_text_active": "#323B4B",
            "portal_sidebar_icon": "#828994",
            "portal_sidebar_icon_hover": "#828994",
            "portal_sidebar_icon_active": "#828994",
            "portal_background": "#F6F6F6",
            "portal_sidebar_account_title": "#11151D",
            "portal_sidebar_account_email": "#828994",
            "portal_sidebar_divider": "#E3E5E9",
            "portal_dashboard_bg_one": "#EF4583",
            "portal_dashboard_bg_two": "#FFC634",
            "portal_sidebar_collapse_button": "#828994",
            "portal_sidebar_collapse_button_hover": "#B3B9C4",
            "portal_sidebar_user_select_background": "#F6F6F6",
            "portal_sidebar_user_select_hover": "#F6F6F6",
            "portal_sidebar_user_select_text": "#323B4B",
            "portal_sidebar_user_select_text_hover": "#323B4B",
            "portal_sidebar_user_select_border": "#EEEEEE",
            "portal_sidebar_user_select_border_hover": "#828994"
          },
          "factfind_pdf_header_background": "#0E0E56",
          "factfind_pdf_header_text": "#ffffff",
          "factfind_pdf_logo": "https://api.plannrcrm.com/images/plannr.jpg",
          "is_subscribed": true,
          "keep_deleted_files_for": 30,
          "tax": 17.5,
          "month_end": 25,
          "statement_frequency": "monthly",
          "billing": {
            "invoice_address_1": "Suite E, 5 The Briars",
            "invoice_address_2": "Waterberry Drive",
            "invoice_town_city": "Waterlooville",
            "invoice_county": "Hampshire",
            "invoice_postcode": "PO7 7YH",
            "invoice_country": "United Kingdom",
            "invoice_email": "gareth@codepotato.co.uk"
          },
          "ip_whitelist": [
            "192.168.0.1",
            "127.0.0.1"
          ],
          "welcome_paragraph_html": "<h1>Welcome.</h1>",
          "email_welcome_paragraph_html": "Welcome to Plannr!",
          "show_fact_find_illustrations": true,
          "cc_email_addresses": [
            "jack@example.com",
            "jill@example.com"
          ],
          "bcc_email_addresses": [
            "jack@example.com",
            "jill@example.com"
          ],
          "reply_to_email_address": "jack@example.com",
          "mobile_app_support_number": "01234 567890",
          "mobile_app_support_email": "support@example.com"
        },
        "primary_phone_number": {
          "uuid": "4559265f-a5cd-42f4-b6b6-5a906387fd8d",
          "created_at": "2026-10-27T15:44:19+00:00",
          "updated_at": "2026-10-27T15:44:19+00:00",
          "type": "phone_number",
          "name": "Work number",
          "value": "+443330903630",
          "phone_number_meta": {
            "country": "GB",
            "formatted": "0333 090 3630"
          }
        },
        "primary_email": {
          "uuid": "4559265f-a5cd-42f4-b6b6-5a906387fd8d",
          "created_at": "2026-10-27T15:44:19+00:00",
          "updated_at": "2026-10-27T15:44:19+00:00",
          "type": "phone_number",
          "name": "Work number",
          "value": "+443330903630",
          "phone_number_meta": {
            "country": "GB",
            "formatted": "0333 090 3630"
          }
        },
        "current_time_entry": {
          "uuid": "2861236c-f438-443d-a86b-8d603be9c801",
          "created_at": "2026-10-27T15:44:19+00:00",
          "updated_at": "2026-10-27T15:44:19+00:00",
          "name": "Research",
          "description": "This is a description.",
          "trackable_type": "Client",
          "start_date": "2026-10-27T14:54:19+00:00",
          "end_date": "2026-10-27T15:22:19+00:00",
          "is_active": true,
          "total_time_in_minutes": 28,
          "computed_time_elapsed_in_seconds": 1680
        },
        "assigned_adviser": {
          "uuid": "4dddfc6e-b0c5-4d17-97fa-67b0f94bf6a1",
          "created_at": "2026-10-27T15:44:19+00:00",
          "updated_at": "2026-10-27T15:44:19+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-27T15:44:19+00:00",
          "next_review_date": "2026-10-27T15:44:19+00:00",
          "previous_review_date": "2026-10-27T15:44:19+00:00",
          "anniversary_review_date": "2026-10-27T15:44:19+00:00",
          "terms_of_business_at": "2026-10-27T15:44:19+00:00",
          "client_agreement_at": "2026-10-27T15:44:19+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-27",
          "last_interaction_at": "2026-10-27 15:44:19",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-27T15:44:19+00:00",
          "out_of_office_until": "2026-10-27T15:44:19+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "assigned_administrator": {
          "uuid": "4dddfc6e-b0c5-4d17-97fa-67b0f94bf6a1",
          "created_at": "2026-10-27T15:44:19+00:00",
          "updated_at": "2026-10-27T15:44:19+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-27T15:44:19+00:00",
          "next_review_date": "2026-10-27T15:44:19+00:00",
          "previous_review_date": "2026-10-27T15:44:19+00:00",
          "anniversary_review_date": "2026-10-27T15:44:19+00:00",
          "terms_of_business_at": "2026-10-27T15:44:19+00:00",
          "client_agreement_at": "2026-10-27T15:44:19+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-27",
          "last_interaction_at": "2026-10-27 15:44:19",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-27T15:44:19+00:00",
          "out_of_office_until": "2026-10-27T15:44:19+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "assigned_paraplanner": {
          "uuid": "4dddfc6e-b0c5-4d17-97fa-67b0f94bf6a1",
          "created_at": "2026-10-27T15:44:19+00:00",
          "updated_at": "2026-10-27T15:44:19+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-27T15:44:19+00:00",
          "next_review_date": "2026-10-27T15:44:19+00:00",
          "previous_review_date": "2026-10-27T15:44:19+00:00",
          "anniversary_review_date": "2026-10-27T15:44:19+00:00",
          "terms_of_business_at": "2026-10-27T15:44:19+00:00",
          "client_agreement_at": "2026-10-27T15:44:19+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-27",
          "last_interaction_at": "2026-10-27 15:44:19",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-27T15:44:19+00:00",
          "out_of_office_until": "2026-10-27T15:44:19+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "introduced_by": {
          "uuid": "4dddfc6e-b0c5-4d17-97fa-67b0f94bf6a1",
          "created_at": "2026-10-27T15:44:19+00:00",
          "updated_at": "2026-10-27T15:44:19+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-27T15:44:19+00:00",
          "next_review_date": "2026-10-27T15:44:19+00:00",
          "previous_review_date": "2026-10-27T15:44:19+00:00",
          "anniversary_review_date": "2026-10-27T15:44:19+00:00",
          "terms_of_business_at": "2026-10-27T15:44:19+00:00",
          "client_agreement_at": "2026-10-27T15:44:19+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-27",
          "last_interaction_at": "2026-10-27 15:44:19",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-27T15:44:19+00:00",
          "out_of_office_until": "2026-10-27T15:44:19+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "business_unit": {
          "uuid": "6d2361e8-ddc8-49fc-858c-799de6b8d89c",
          "name": "Wealth Management",
          "has_alternative_branding": false,
          "brand_colours": [],
          "members_count": 3,
          "groups_count": 2,
          "created_at": "2026-10-27T15:44:19+00:00",
          "updated_at": "2026-10-27T15:44:19+00:00"
        },
        "groups": {
          "uuid": null,
          "name": "finance",
          "slug": "finance",
          "participants_count": "3",
          "participants": {
            "uuid": {
              "example": null,
              "description": "UUID of the account"
            },
            "role": {
              "example": "client",
              "description": "Role of the account"
            },
            "first_name": {
              "example": "Gareth",
              "description": "First name of the account"
            },
            "last_name": {
              "example": "Thompson",
              "description": "Last name of the account"
            },
            "name": {
              "example": "Gareth Thompson",
              "description": "Name of the account"
            },
            "email": {
              "example": "gareth@codepotato.co.uk",
              "description": "Email of the account"
            }
          },
          "created_at": "2026-10-27T15:44:19+00:00",
          "updated_at": "2026-10-27T15:44:19+00:00"
        },
        "tags": {
          "uuid": "60fa4ac5-c7da-4322-8857-f84d517e6edc",
          "created_at": "2026-10-27T15:44:19+00:00",
          "updated_at": "2026-10-27T15:44:19+00:00",
          "name": "Mortgage",
          "slug": "mortgage",
          "colour": "#ef4582"
        },
        "marketing_consent": {
          "email": "opted_in",
          "phone": "opted_out",
          "letter": "not_captured",
          "sms": "not_captured"
        },
        "owners": {
          "uuid": "4dddfc6e-b0c5-4d17-97fa-67b0f94bf6a1",
          "created_at": "2026-10-27T15:44:19+00:00",
          "updated_at": "2026-10-27T15:44:19+00:00",
          "type": "client",
          "role": "client",
          "first_name": "Gareth",
          "last_name": "Thompson",
          "name": "Gareth Thompson",
          "email": "gareth@codepotato.co.uk",
          "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
          "first_contact_date": "2026-10-27T15:44:19+00:00",
          "next_review_date": "2026-10-27T15:44:19+00:00",
          "previous_review_date": "2026-10-27T15:44:19+00:00",
          "anniversary_review_date": "2026-10-27T15:44:19+00:00",
          "terms_of_business_at": "2026-10-27T15:44:19+00:00",
          "client_agreement_at": "2026-10-27T15:44:19+00:00",
          "with_login": true,
          "has_joint_account": true,
          "can_be_deleted": "false",
          "ownership_percentage": 100.0,
          "inactive_at": "2026-10-27",
          "last_interaction_at": "2026-10-27 15:44:19",
          "referral_code": "ABC12345",
          "is_out_of_office": true,
          "out_of_office_from": "2026-10-27T15:44:19+00:00",
          "out_of_office_until": "2026-10-27T15:44:19+00:00",
          "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
          "is_pending_fact_find_account": false,
          "permissions": {
            "firm:read": [
              "firm"
            ],
            "network:read": [
              "network:uuid"
            ]
          },
          "managed_by_head_office": false
        },
        "first_contact_date": "2026-10-27T15:44:14+00:00",
        "next_review_date": "2026-10-27T15:44:14+00:00",
        "previous_review_date": "2026-10-27T15:44:14+00:00",
        "anniversary_review_date": "2026-10-27T15:44:14+00:00",
        "terms_of_business_at": "2026-10-27T15:44:14+00:00",
        "client_agreement_at": "2026-10-27T15:44:14+00:00",
        "with_login": true,
        "has_joint_account": true,
        "can_be_deleted": "false",
        "joint_account_circle": {
          "uuid": "1d17325c-dac7-4cd5-a8e5-e0b49c35fd42",
          "created_at": "2026-10-27T15:44:19+00:00",
          "updated_at": "2026-10-27T15:44:19+00:00",
          "name": "Jones Family",
          "photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
          "bg_colour": "#35f4e1",
          "has_portal_access": true,
          "portal_access_status": "active",
          "engagement_rating": "green",
          "last_login": {
            "logged_in_at": "2026-10-27T15:44:19+00:00",
            "account_uuid": "uuid",
            "account_name": "John Smith",
            "device_type": "desktop",
            "device_platform": "macos"
          },
          "portal_login_count_30d": 5,
          "portal_login_count_90d": 12,
          "portal_login_count_365d": 48,
          "joint_account_uuid": "f54f0038-0b73-4343-902b-4ad67ed7dd70",
          "login_access_level": "write",
          "current_life_stage_uuid": "34140164-7184-4a44-a06d-b73f9fc0f6c1"
        },
        "circles": {
          "uuid": "1d17325c-dac7-4cd5-a8e5-e0b49c35fd42",
          "created_at": "2026-10-27T15:44:19+00:00",
          "updated_at": "2026-10-27T15:44:19+00:00",
          "name": "Jones Family",
          "photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
          "bg_colour": "#35f4e1",
          "has_portal_access": true,
          "portal_access_status": "active",
          "engagement_rating": "green",
          "last_login": {
            "logged_in_at": "2026-10-27T15:44:19+00:00",
            "account_uuid": "uuid",
            "account_name": "John Smith",
            "device_type": "desktop",
            "device_platform": "macos"
          },
          "portal_login_count_30d": 5,
          "portal_login_count_90d": 12,
          "portal_login_count_365d": 48,
          "joint_account_uuid": "f54f0038-0b73-4343-902b-4ad67ed7dd70",
          "login_access_level": "write",
          "current_life_stage_uuid": "34140164-7184-4a44-a06d-b73f9fc0f6c1"
        },
        "ownership_percentage": 100,
        "inactive_at": "2026-10-27",
        "last_interaction_at": "2026-10-27 15:44:14",
        "referral_code": "ABC12345",
        "is_out_of_office": true,
        "out_of_office_from": "2026-10-27T15:44:14+00:00",
        "out_of_office_until": "2026-10-27T15:44:14+00:00",
        "out_of_office_message": "I am away this week. For urgent matters please contact the office.",
        "service_level": {
          "uuid": "a74cecdf-47a3-46d1-ae47-f2381c1a160c",
          "name": "Gold",
          "created_at": "2026-10-27T15:44:19+00:00",
          "updated_at": "2026-10-27T15:44:19+00:00"
        },
        "is_pending_fact_find_account": false,
        "permissions": {
          "firm:read": [
            "firm"
          ],
          "network:read": [
            "network:uuid"
          ]
        },
        "managed_by_head_office": false,
        "custom_fields": {
          "uuid": null,
          "created_at": "2026-10-27T15:44:19+00:00",
          "updated_at": "2026-10-27T15:44:19+00:00",
          "type": "string",
          "name": "Favourite Drink",
          "reference": "favourite_drink",
          "is_required": false,
          "value": "Coffee",
          "selection_options": [
            "Coffee",
            "Tea",
            "Water"
          ],
          "help_text": "This is the client's favourite drink."
        },
        "external_references": {
          "uuid": "97a5f63a-a7c9-4e65-98af-59bd893fe6d4",
          "created_at": "2026-10-27T15:44:19+00:00",
          "updated_at": "2026-10-27T15:44:19+00:00",
          "third_party": "nucleus",
          "reference": "AB123456"
        }
      },
      "report_type_id": "rmar",
      "status": "complete",
      "progress": 100,
      "files": [
        {
          "uuid": "a9d29d8d-922e-4cab-97e3-88b1d1b2a3ee",
          "created_at": "2026-10-27T15:44:14+00:00",
          "original_created_at": "2026-10-27T15:44:14+00:00",
          "updated_at": "2026-10-27T15:44:14+00:00",
          "uploaded_at": "2026-10-27T15:44:14+00:00",
          "status": "uploaded",
          "filename": "Welcome to Plannr.pdf",
          "name": "Welcome to Plannr",
          "extension": "pdf",
          "type": "type",
          "size": "21691783",
          "path": "Gareth Thompson/Subfolder/Welcome to Plannr.pdf",
          "last_modified": "2026-10-27T15:44:14+00:00",
          "progress": "100",
          "download_url": "https://api.plannrcrm.com/file/ddfb0b74-bd0f-4897-b9ae-3a2fa1e86906/download",
          "preview_url": "https://api.plannrcrm.com/file/feb4ce00-691d-499a-a862-49676eb792e7/preview",
          "folder_name": "folder 2",
          "folder": {
            "uuid": "7f19bb3b-b735-4216-832c-d5b66f3e5fff",
            "created_at": "2026-10-27T15:44:19+00:00",
            "updated_at": "2026-10-27T15:44:19+00:00",
            "name": "Important Documents",
            "slug": "important-documents",
            "path": "Codepotato/Important Documents",
            "clients_read": true,
            "clients_write": true,
            "show_client_permissions": true,
            "is_system_folder": true,
            "is_pseudo_folder": true,
            "is_root_folder": true,
            "documentable_type": "account",
            "documentable_uuid": "account",
            "documentable": "Object",
            "participants_count": 3,
            "folders_count": 5,
            "files_count": 8,
            "depth": 5,
            "owned": false
          },
          "documentable_type": "account",
          "documentable": "Object",
          "navigator": {
            "model_type": "account",
            "model_uuid": "0dbc2370-01d7-4c00-bbd4-9aaf789d4aaf"
          },
          "firm": {
            "uuid": "c34e39d6-b8b3-47ab-a2e1-4989626570e4",
            "created_at": "2026-10-27T15:44:19+00:00",
            "updated_at": "2026-10-27T15:44:19+00:00",
            "name": "Codepotato",
            "slug": "codepotato",
            "address_1": "Suite E, 5 The Briars",
            "address_2": "Waterberry Drive",
            "town_city": "Waterlooville",
            "county": "Hampshire",
            "postcode": "PO7 7YH",
            "country": "United Kingdom",
            "regulatory_text": "Regulatory text",
            "logo": "https://api.plannrcrm.com/images/plannr.jpg",
            "logo_icon": "https://api.plannrcrm.com/images/plannr-icon.jpg",
            "brand_colours": {
              "sidebar_background": "#0E0E56",
              "sidebar_accent": "#36367E",
              "sidebar_text": "#FFFFFF",
              "sidebar_hover": "#0A0A42",
              "sidebar_active": "#53DBB8",
              "sidebar_title_background": "#36367E",
              "sidebar_title_primary": "#FFC634",
              "sidebar_title_secondary": "#FFFFFF",
              "sidebar_title_secondary_hover": "#FFFFFF",
              "email_background": "#0E0E56",
              "email_logo_background_panel": "#36367E",
              "email_sub_text": "#FFFFFF",
              "email_button_background": "#36367E",
              "email_button_text": "#FFFFFF",
              "portal_sidebar_button_background": "#F6F6F6",
              "portal_sidebar_button_hover": "#FFFFFF",
              "portal_sidebar_button_active": "#FFFFFF",
              "portal_brand_title": "#323B4B",
              "portal_brand_sub_title": "#828994",
              "portal_sidebar_title": "#11151D",
              "portal_sidebar_text": "#323B4B",
              "portal_sidebar_text_hover": "#323B4B",
              "portal_sidebar_text_active": "#323B4B",
              "portal_sidebar_icon": "#828994",
              "portal_sidebar_icon_hover": "#828994",
              "portal_sidebar_icon_active": "#828994",
              "portal_background": "#F6F6F6",
              "portal_sidebar_account_title": "#11151D",
              "portal_sidebar_account_email": "#828994",
              "portal_sidebar_divider": "#E3E5E9",
              "portal_dashboard_bg_one": "#EF4583",
              "portal_dashboard_bg_two": "#FFC634",
              "portal_sidebar_collapse_button": "#828994",
              "portal_sidebar_collapse_button_hover": "#B3B9C4",
              "portal_sidebar_user_select_background": "#F6F6F6",
              "portal_sidebar_user_select_hover": "#F6F6F6",
              "portal_sidebar_user_select_text": "#323B4B",
              "portal_sidebar_user_select_text_hover": "#323B4B",
              "portal_sidebar_user_select_border": "#EEEEEE",
              "portal_sidebar_user_select_border_hover": "#828994"
            },
            "factfind_pdf_header_background": "#0E0E56",
            "factfind_pdf_header_text": "#ffffff",
            "factfind_pdf_logo": "https://api.plannrcrm.com/images/plannr.jpg",
            "is_subscribed": true,
            "keep_deleted_files_for": 30,
            "tax": 17.5,
            "month_end": 25,
            "statement_frequency": "monthly",
            "billing": {
              "invoice_address_1": "Suite E, 5 The Briars",
              "invoice_address_2": "Waterberry Drive",
              "invoice_town_city": "Waterlooville",
              "invoice_county": "Hampshire",
              "invoice_postcode": "PO7 7YH",
              "invoice_country": "United Kingdom",
              "invoice_email": "gareth@codepotato.co.uk"
            },
            "ip_whitelist": [
              "192.168.0.1",
              "127.0.0.1"
            ],
            "welcome_paragraph_html": "<h1>Welcome.</h1>",
            "email_welcome_paragraph_html": "Welcome to Plannr!",
            "show_fact_find_illustrations": true,
            "cc_email_addresses": [
              "jack@example.com",
              "jill@example.com"
            ],
            "bcc_email_addresses": [
              "jack@example.com",
              "jill@example.com"
            ],
            "reply_to_email_address": "jack@example.com",
            "mobile_app_support_number": "01234 567890",
            "mobile_app_support_email": "support@example.com"
          },
          "account": {
            "uuid": "a03322be-d7aa-4abd-b873-6ae503ace2ab",
            "created_at": "2026-10-27T15:44:19+00:00",
            "updated_at": "2026-10-27T15:44:19+00:00",
            "type": "client",
            "role": "client",
            "first_name": "Gareth",
            "last_name": "Thompson",
            "name": "Gareth Thompson",
            "email": "gareth@codepotato.co.uk",
            "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson"
          },
          "tags": {
            "uuid": "60fa4ac5-c7da-4322-8857-f84d517e6edc",
            "created_at": "2026-10-27T15:44:19+00:00",
            "updated_at": "2026-10-27T15:44:19+00:00",
            "name": "Mortgage",
            "slug": "mortgage",
            "colour": "#ef4582"
          }
        }
      ],
      "folder": {
        "uuid": "bfb97f45-cf49-442b-b03b-afc74ad84b5f",
        "created_at": "2026-10-27T15:44:14+00:00",
        "updated_at": "2026-10-27T15:44:14+00:00",
        "name": "Important Documents",
        "slug": "important-documents",
        "path": "Codepotato/Important Documents",
        "clients_read": true,
        "clients_write": true,
        "show_client_permissions": true,
        "is_system_folder": true,
        "is_pseudo_folder": true,
        "is_root_folder": true,
        "documentable_type": "account",
        "documentable_uuid": "account",
        "documentable": "Object",
        "participants_count": 3,
        "participants": {
          "uuid": "e9d2bdaa-9eb8-41bd-a5c2-ebe89c4bf108",
          "created_at": "2026-10-27T15:44:19+00:00",
          "updated_at": "2026-10-27T15:44:19+00:00",
          "name": "Gareth Thompson",
          "write": true
        },
        "folders_count": 5,
        "folders": {
          "uuid": "7f19bb3b-b735-4216-832c-d5b66f3e5fff",
          "created_at": "2026-10-27T15:44:19+00:00",
          "updated_at": "2026-10-27T15:44:19+00:00",
          "name": "Important Documents",
          "slug": "important-documents",
          "path": "Codepotato/Important Documents",
          "clients_read": true,
          "clients_write": true,
          "show_client_permissions": true,
          "is_system_folder": true,
          "is_pseudo_folder": true,
          "is_root_folder": true,
          "documentable_type": "account",
          "documentable_uuid": "account",
          "documentable": "Object",
          "participants_count": 3,
          "folders_count": 5,
          "files_count": 8,
          "depth": 5,
          "owned": false
        },
        "files_count": 8,
        "files": {
          "uuid": "8ace5e91-91fa-4080-a2ca-f757f71b48f4",
          "created_at": "2026-10-27T15:44:19+00:00",
          "original_created_at": "2026-10-27T15:44:19+00:00",
          "updated_at": "2026-10-27T15:44:19+00:00",
          "uploaded_at": "2026-10-27T15:44:19+00:00",
          "status": "uploaded",
          "filename": "Welcome to Plannr.pdf",
          "name": "Welcome to Plannr",
          "extension": "pdf",
          "type": "type",
          "size": "21691783",
          "path": "Gareth Thompson/Subfolder/Welcome to Plannr.pdf",
          "last_modified": "2026-10-27T15:44:19+00:00",
          "progress": "100",
          "download_url": "https://api.plannrcrm.com/file/728c4c3c-f1d7-429c-99e4-e765e6ef93ac/download",
          "preview_url": "https://api.plannrcrm.com/file/ce8aa696-4d51-4a26-860f-bcd1b890c280/preview",
          "folder_name": "folder 2",
          "documentable_type": "account",
          "documentable": "Object",
          "navigator": {
            "model_type": "account",
            "model_uuid": null
          }
        },
        "parents": {
          "uuid": "7f19bb3b-b735-4216-832c-d5b66f3e5fff",
          "created_at": "2026-10-27T15:44:19+00:00",
          "updated_at": "2026-10-27T15:44:19+00:00",
          "name": "Important Documents",
          "slug": "important-documents",
          "path": "Codepotato/Important Documents",
          "clients_read": true,
          "clients_write": true,
          "show_client_permissions": true,
          "is_system_folder": true,
          "is_pseudo_folder": true,
          "is_root_folder": true,
          "documentable_type": "account",
          "documentable_uuid": "account",
          "documentable": "Object",
          "participants_count": 3,
          "folders_count": 5,
          "files_count": 8,
          "depth": 5,
          "owned": false
        },
        "ancestors": {
          "uuid": "7f19bb3b-b735-4216-832c-d5b66f3e5fff",
          "created_at": "2026-10-27T15:44:19+00:00",
          "updated_at": "2026-10-27T15:44:19+00:00",
          "name": "Important Documents",
          "slug": "important-documents",
          "path": "Codepotato/Important Documents",
          "clients_read": true,
          "clients_write": true,
          "show_client_permissions": true,
          "is_system_folder": true,
          "is_pseudo_folder": true,
          "is_root_folder": true,
          "documentable_type": "account",
          "documentable_uuid": "account",
          "documentable": "Object",
          "participants_count": 3,
          "folders_count": 5,
          "files_count": 8,
          "depth": 5,
          "owned": false
        },
        "children": {
          "uuid": "7f19bb3b-b735-4216-832c-d5b66f3e5fff",
          "created_at": "2026-10-27T15:44:19+00:00",
          "updated_at": "2026-10-27T15:44:19+00:00",
          "name": "Important Documents",
          "slug": "important-documents",
          "path": "Codepotato/Important Documents",
          "clients_read": true,
          "clients_write": true,
          "show_client_permissions": true,
          "is_system_folder": true,
          "is_pseudo_folder": true,
          "is_root_folder": true,
          "documentable_type": "account",
          "documentable_uuid": "account",
          "documentable": "Object",
          "participants_count": 3,
          "folders_count": 5,
          "files_count": 8,
          "depth": 5,
          "owned": false
        },
        "depth": 5,
        "owned": false
      },
      "can_delete": true
    }
  ]
}