---
title: "Settings this flow accepts when you run it"
method: GET
path: "/syncs/{syncid}/flows/{flowid}/settings"
tags: ["Syncs"]
---

# Settings this flow accepts when you run it

`GET /syncs/{syncid}/flows/{flowid}/settings`

## Request

- Base URL: `https://api.chift.eu`
- URL: `https://api.chift.eu/syncs/{syncid}/flows/{flowid}/settings`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/chift/apis/chift-api/docs/syncs/:syncid/flows/:flowid/settings/get.ts> (a function with typed inputs; its response is checked against the schema)

Lists the settings you can pass when running this flow: the period to cover, whether the run writes for real, whether data already synchronised is exported again, and how much it logs. Each setting comes with its type, its options and a short explanation, as text in the requested language. Settings this flow cannot apply are not listed.

## Path parameters

- `syncid` string, required
- `flowid` string, required

## Query parameters

- `language` string: Language of the titles and explanations, falling back to English.

## Response `200`

Successful Response

- FlowSettingsResponse
  - `configurable` boolean, required: Whether this flow declares which settings it honours. False means it has not been migrated to the settings vocabulary yet: run it through the deprecated event route instead of offering the settings form.
  - `groups` SettingGroupItem[], required
    - `key` 'period' | 'write' | 'state' | 'observability' | 'scope', required: Non-overlapping concerns. A setting belongs to exactly one.
    - `title` string, required
  - `settings` SettingField[], required
    - `key` string, required
    - `type` 'date' | 'str' | 'bool' | 'int' | 'enum' | 'str_list' | 'dict', required: The input control the frontend should render for a setting.
    - `group` 'period' | 'write' | 'state' | 'observability' | 'scope', required: Non-overlapping concerns. A setting belongs to exactly one.
    - `title` string, required
    - `tooltip` string, required
    - `default` unknown
    - `options` SettingOption[]
      - `value` string, required
      - `title` string, required
    - `supported` boolean
    - `unsupported_reason` string, nullable

## Other responses

- `400`: Bad Request
- `404`: Not Found
- `409`: Conflict
- `422`: Unprocessable Entity

## Changes

- **2026-11-03** `020884969534`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/chift/apis/chift-api/changes/syncs/:syncid/flows/:flowid/settings/get.md)

---

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