Path parameters

• uuid string Required

Responses

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

  • uuid string

    The UUID of the resource.

  • created_at string

    The timestamp of when the resource was created.

  • updated_at string

    The timestamp of when the resource was updated.

  • name string

    Name of the firm

  • slug string

    Slug of the firm

  • address_1 string

    First line of the address

  • address_2 string

    Second line of the address

  • town_city string

    Town/City

  • county string

    County

  • postcode string

    Postcode

  • country string

    Country

  • regulatory_text string

    Regulatory text of the firm.

  • logo string

    URL of your firm logo.

  • logo_icon string

    URL of your firm logo icon.

  • brand_colours object

    Firm branding colours.

    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

    Subscription status.

  • addon_subscriptions array[object]

    All addons the firm is subscribed to.

    Hide addon_subscriptions attributes Show addon_subscriptions attributes object

    • uuid string
    • created_at string
    • updated_at string
    • enabled string
    • addon object
      Hide addon attributes Show addon attributes object

      • id

        Unique identifier for this addon

      • name

        Short descriptive name for the addon

      • description

        Description of the addons functions

      • setup_instructions

        Setup instructions for the user

      • category

        Addon Category

      • params

        Configuration Parameters

      • banner_url

        Url for banner image

      • icon_url

        Url for Icon image

      • price

        Price of the addon

      • can_be_subscribed_to

        Denotes if the addon can be subscribed to.

      • is_visible

        Denotes if the addon can shown on the addon page.

      • free_trial_days

        Number of days the addon is free for. This only applies for paid for addons.

      • should_poll_for_subscription_changes

        Denotes if the front-end should poll/refresh for subscription changes. This is useful for add-ons managed remotely.

    • trial_ends_at string
    • trial_ends_in_days integer
    • payment_confirmed_at string
  • keep_deleted_files_for integer

    Number of days to keep deleted files for

  • tax number

    Tax percent

  • month_end integer

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

  • statement_frequency string

    The frequency of the income reconciliation statements

  • billing object

    Firm invoice details for billing

    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

    The task board template that is used when every client or case is created

    Hide task_board_template attributes Show task_board_template attributes object

    • uuid string
    • created_at string
    • updated_at string
    • is_template boolean
    • name string
    • default_list_uuid string
    • lists string
    • is_editable boolean
    • priorities array[object]
      Hide priorities attributes Show priorities attributes object

      • name string
      • value string
    • modelable object
      Hide modelable attributes Show modelable 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 case

      • slug

        Slug of the case

      • review_at

        Timestamp of when the case should be reviewed

      • assigned_to_uuids

        UUIDs of accounts that will be assigned to the case when it is created.

      • group_uuids

        UUIDs of groups that will be assigned when the case is created.

      • completed_at

        Timestamp of when the case was completed

      • value

        Expected value of this case

      • status_position

        The case status's position on the status list. Starting from 1. Only used if you are formatting cases in a kanban layout.

      • participants_count

        The number of participants on the case

      • task_board_uuid

        UUID of the task board

  • ip_whitelist array[string]

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

  • welcome_paragraph_html string

    Custom welcome paragraph html for the branded auth welcome page

  • email_welcome_paragraph_html string

    Custom welcome paragraph for the welcome/new user email

  • show_fact_find_illustrations boolean

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

  • cc_email_addresses array[string]

    Array of email cc addresses.

  • bcc_email_addresses array[string]

    Array of email bcc addresses.

  • reply_to_email_address string

    Firm reply to email address.

  • mobile_app_support_number string

    Firm mobile app support number.

  • mobile_app_support_email string

    Firm mobile app support email address.