> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chift.eu/llms.txt
> Use this file to discover all available pages before exploring further.

# Settings this flow accepts when you run it

> 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.



## OpenAPI

````yaml get /syncs/{syncid}/flows/{flowid}/settings
openapi: 3.1.0
info:
  title: Chift API
  description: >-
    The Chift API is a universal API giving you access to financial data from
    the software of your clients. It helps software companies to offer native
    integrations to their clients without the effort needed to maintain those
    native integrations. By using the APIs (Accounting, POS, eCommerce) of
    Chift, you connect once and allow your clients to use their software
    packages.
  version: 1.0.0
servers:
  - url: https://api.chift.eu
    description: Chift
security:
  - bearerAuth: []
paths:
  /syncs/{syncid}/flows/{flowid}/settings:
    get:
      tags:
        - Syncs
      summary: Settings this flow accepts when you run it
      description: >-
        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.
      operationId: syncs_get_flow_settings
      parameters:
        - name: syncid
          in: path
          required: true
          schema:
            type: string
            title: Syncid
        - name: flowid
          in: path
          required: true
          schema:
            type: string
            title: Flowid
        - name: language
          in: query
          required: false
          schema:
            type: string
            description: Language of the titles and explanations, falling back to English.
            default: EN
            title: Language
          description: Language of the titles and explanations, falling back to English.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FlowSettingsResponse'
        '400':
          content:
            application/json:
              example:
                message: You cannot execute for all consumers on marketplace accounts
                status: error
              schema:
                $ref: '#/components/schemas/ChiftError'
          description: Bad Request
        '404':
          content:
            application/json:
              example:
                message: The flow does not exist
                status: error
              schema:
                $ref: '#/components/schemas/ChiftError'
          description: Not Found
        '409':
          content:
            application/json:
              example:
                message: An execution of this flow is already running for this consumer
                status: error
              schema:
                $ref: '#/components/schemas/ChiftError'
          description: Conflict
        '422':
          content:
            application/json:
              example:
                message: This flow cannot apply one of the settings
                status: error
              schema:
                $ref: '#/components/schemas/ChiftError'
          description: Unprocessable Entity
components:
  schemas:
    FlowSettingsResponse:
      properties:
        configurable:
          type: boolean
          title: Configurable
          description: >-
            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:
          items:
            $ref: '#/components/schemas/SettingGroupItem'
          type: array
          title: Groups
        settings:
          items:
            $ref: '#/components/schemas/SettingField'
          type: array
          title: Settings
      type: object
      required:
        - configurable
        - groups
        - settings
      title: FlowSettingsResponse
    ChiftError:
      properties:
        message:
          type: string
          title: Message
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
          default: error
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
          default: ''
        error_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Error Code
      type: object
      required:
        - message
      title: ChiftError
    SettingGroupItem:
      properties:
        key:
          $ref: '#/components/schemas/SettingGroup'
        title:
          type: string
          title: Title
      type: object
      required:
        - key
        - title
      title: SettingGroupItem
    SettingField:
      properties:
        key:
          type: string
          title: Key
        type:
          $ref: '#/components/schemas/SettingType'
        group:
          $ref: '#/components/schemas/SettingGroup'
        title:
          type: string
          title: Title
        tooltip:
          type: string
          title: Tooltip
        default:
          title: Default
        options:
          items:
            $ref: '#/components/schemas/SettingOption'
          type: array
          title: Options
          default: []
        supported:
          type: boolean
          title: Supported
          default: true
        unsupported_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Unsupported Reason
      type: object
      required:
        - key
        - type
        - group
        - title
        - tooltip
      title: SettingField
      description: 'Declaration of one setting: everything a client needs to render it.'
    SettingGroup:
      type: string
      enum:
        - period
        - write
        - state
        - observability
        - scope
      title: SettingGroup
      description: Non-overlapping concerns. A setting belongs to exactly one.
    SettingType:
      type: string
      enum:
        - date
        - str
        - bool
        - int
        - enum
        - str_list
        - dict
      title: SettingType
      description: The input control the frontend should render for a setting.
    SettingOption:
      properties:
        value:
          type: string
          title: Value
        title:
          type: string
          title: Title
      type: object
      required:
        - value
        - title
      title: SettingOption
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        This access token needs to be included in each of your request to the
        Chift API.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.