Query parameters

• filter[uuid] string

  Filter by a comma separated list of UUIDs.

• filter[model_type] string

  Filter the custom fields by a specific model type. For example: ?filter[model_type]=client

• sort string

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

• per_page integer

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

Responses

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

  • uuid string

    The UUID of the custom field

  • created_at string

    The timestamp of when the resource was created.

  • updated_at string

    The timestamp of when the resource was updated.

  • type string

    The type of custom field

  • name string

    The name of the custom field

  • reference string

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

  • is_required boolean

    Denotes if the custom field is required

  • model_type string

    The type of model that the custom field is for.

  • help_text string

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

  • firm object

    The custom field firm

    Hide firm attributes Show firm attributes object

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

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

      • invoice_address_1 string
      • invoice_address_2 string
      • invoice_town_city string
      • invoice_county string
      • invoice_postcode string
      • invoice_country string
      • invoice_email string
    • task_board_template string
    • ip_whitelist array[string]
    • welcome_paragraph_html string
    • email_welcome_paragraph_html string
    • show_fact_find_illustrations boolean
    • 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
  • selection_options array[string]

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

  • is_visible_to_clients boolean

    Denotes if the custom field is visible and editable to clients.

  • position integer

    The position of the custom field

  • conditions array[object]

    The conditions that must be met for this custom field to apply. Empty array means no conditions.

    Hide conditions attributes Show conditions attributes object

    • attribute string
    • values array[string]
  • conditions_operator string

    The logical operator for combining conditions. "all" (AND) or "any" (OR).