---
title: "Get Comprehensive Settings"
method: GET
path: "/api/v1/settings/comprehensive"
tags: ["settings"]
---

# Get Comprehensive Settings

`GET /api/v1/settings/comprehensive`

## Request

- Base URL: `https://api.peil.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.peil.app/api/v1/settings/comprehensive`
- Auth: OAuth 2 (password, token URL `/api/v1/auth/jwt/login`)

Get comprehensive settings with full financial, locale, and AOV configuration

## Response `200`

Successful Response

- ComprehensiveSettings: Complete user settings matching legacy functionality
  - `financial` FinancialSettings: Financial planning and calculation settings
    - `buffer_percentage` number
    - `monthly_personal_investment` number
    - `monthly_living_costs` number
    - `liquid_savings` number
    - `annual_hour_growth_rate` number
    - `annual_rate_increase` number
    - `rolling_average_months` integer
    - `tax_calculation_method` string
    - `include_aov_in_calculations` boolean
    - `home_office_deduction_percentage` number
    - `business_auto_percentage` number
    - `target_savings_rate` number
    - `retirement_contribution_rate` number
    - `emergency_fund_months` integer
    - `average_payment_delay_days` integer
    - `bad_debt_percentage` number
    - `market_rate_adjustment` number
    - `skill_premium_growth` number
    - `cost_inflation_rate` number
    - `healthcare_cost_growth` number
  - `locale` LocaleSettings: Locale and display settings
    - `currency` string
    - `number_format` string
    - `time_format` string
    - `date_format` string
    - `default_workday_hours` number
    - `default_start_time` string
    - `default_end_time` string
    - `default_hourly_rate` number, nullable
    - `default_client_id` integer, nullable
  - `aov` AOVSettings: Dutch AOV (freelance insurance) settings - Progressive yearly rates
    - `schedule` object
    - `start_year` integer
  - `widgets` WidgetSettings: Dashboard widget configuration and preferences
    - `enabled_widgets` string[]
    - `widget_order` object
    - `widget_layout` object
    - `hidden_widgets` string[]
    - `widget_categories_enabled` object
  - `deduction_overrides` object
  - `active_projection_rate` number, nullable
  - `kor_active` boolean
  - `startersaftrek_override` boolean, nullable
  - `attach_ubl_to_email` boolean

---

[API](https://skmtc.dev/peil/apis/peil-api.md) · [All operations](https://skmtc.dev/peil/apis/peil-api/llms.txt) · [OpenAPI document](https://skmtc.dev/peil/apis/peil-api/revisions/ee3ca1246dde?raw)