---
title: "Get Settings"
method: GET
path: "/developer/settlement-metrics/settings"
tags: ["Developer", "Developer - Settlement Metrics"]
---

# Get Settings

`GET /developer/settlement-metrics/settings`

## Request

- Base URL: `https://api.openintake.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.openintake.ai/developer/settlement-metrics/settings`
- Auth: none declared

## Response `200`

Successful Response

- MetricsStatus
  - `customer_name` string
  - `settings` MetricsSettings, required
    - `timezone` string
    - `teams` MetricTeam[]
      - `id` string, required
      - `name` string, required
      - `color` string, required
      - `transfer_destination_id` string, uuid, nullable
      - `excluded` boolean
    - `defaults` DisplaySettings
      - `team_ids` string[]
      - `periods` string[]
      - `rotation_seconds` integer
      - `major_threshold` integer
      - `sound_enabled` boolean
      - `volume` number
      - `quiet_start` integer, nullable
      - `quiet_end` integer, nullable
      - `show_race` boolean
      - `show_activity` boolean
      - `show_last_month` boolean
      - `show_retained` boolean
      - `scale` number
      - `theme` 'default' | 'monogram' | 'monogram_light' | 'cream'
    - `hide_last_month` boolean
    - `settled_by_ignored_staff_ids` integer[]
  - `sync_enabled` boolean
  - `source_synced_at` string, date-time, nullable
  - `source_error` string, nullable
  - `unattributed_count` integer
  - `unattributed_amount` number
  - `config_version` integer

## Changes

- **2026-10-06** `dbd6e3ee7afe`: 1 info
  - added the optional property `settings/defaults/theme` to the response with the `200` status
- **2026-10-02** `cbec4df5dc85`: 2 info
  - added the optional property `settings/defaults/show_retained` to the response with the `200` status
  - added the optional property `settings/settled_by_ignored_staff_ids` to the response with the `200` status
- **2026-09-29** `318400082d74`: 2 warning, 1 info
  - added the new `quarter` enum value to the `settings/defaults/periods/items/` response property for the response status `200`
  - added the new `year` enum value to the `settings/defaults/periods/items/` response property for the response status `200`
  - added the optional property `sync_enabled` to the response with the `200` status
- **2026-09-26** `7296f576bb94`: 1 warning, 1 info
  - removed the optional property `sync_enabled` from the response with the `200` status
  - added the optional property `settings/hide_last_month` to the response with the `200` status
- **2026-09-17** `0afcd7c31ce2`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/openintake/apis/openintake-api/changes/developer/settlement-metrics/settings/get.md)

---

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