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

# Get settings of a client



## OpenAPI

````yaml https://dev.enneo.dev/api/mind/docs/open-api get /settings
openapi: 3.0.0
info:
  version: '1'
  title: enneo.MIND API
  description: This describes the API of enneo Mind, the main ticketing backend
  contact:
    name: enneo GmbH
    email: richard@enneo.ai
  license:
    name: Proprietary software
    url: https://enneo.ai
servers:
  - url: https://demo.enneo.ai/api/mind
    description: Production server, demo client
  - url: https://main.enneo.dev/api/mind
    description: Development main branch
  - url: http://localhost:8005/api/mind
    description: Local development server
security:
  - bearerAuth:
      - api
  - cookieAuth:
      - api
paths:
  /settings:
    get:
      tags:
        - Settings
      summary: Get settings of a client
      operationId: getSettings
      parameters:
        - name: filterByName
          in: query
          description: Filter by name of the setting
          required: false
          schema:
            type: string
        - name: filterByUsedBy
          in: query
          description: Filter by which module uses the setting
          required: false
          schema:
            type: string
        - name: filterByCategory
          in: query
          description: Filter by category of the setting
          required: false
          schema:
            type: string
        - name: showSecrets
          in: query
          description: Whether to show secrets in the result
          required: false
          schema:
            type: boolean
      responses:
        '200':
          description: |
            List of client-specific configruation settings.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Settings'
        '403':
          description: Unauthorized
        '500':
          description: Internal error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Settings:
      type: object
      description: Settings object
      properties:
        name:
          type: string
          example: ticketingSystem
        category:
          type: string
          example: email
        group:
          type: string
          example: Generic E-Mail Settings
          nullable: true
        label:
          type: string
          example: Ticketing system in use
        description:
          type: string
          example: Enneo supports multiple ticketing systems. Please select one.
        type:
          type: string
          example: select
          description: >-
            Format in which the FE should render this setting. Follows the enneo
            standard dynamic intent form options specified in Notion
          enum:
            - text
            - date
            - radio
            - number
            - integer
            - checkbox
            - textarea
            - select
            - json
            - executor
            - executors
            - multiselect
        config:
          type: object
          description: >-
            Additional configuration properties that are dependant on type or
            rarely used
          nullable: true
          default: null
          properties:
            options:
              description: >-
                If type is 'select', then this lists the dropdown options
                available to the user
              type: array
              items:
                type: object
                properties:
                  value:
                    type: string
                    description: The internal value representing the option.
                    example: internal
                  label:
                    type: string
                    description: The display label for the option.
                    example: Enneo-internal ticketing system
            readonly:
              type: boolean
              description: Information that the FE should render this field as a readonly
              example: false
              default: false
            password:
              type: boolean
              description: >-
                Information that this is sensitive information. Value will only
                be returned if the user has sufficient permissions, and if the
                query parameter showSecrets=true was provided
              example: false
              default: false
            additionalProperties:
              type: object
        value:
          anyOf:
            - type: string
            - type: integer
            - type: boolean
            - type: object
            - type: array
          example: internal
        defaultValue:
          anyOf:
            - type: string
            - type: integer
            - type: boolean
            - type: object
            - type: array
          example: internal
    Error:
      type: object
      description: Data format of Enneo error messages
      properties:
        error:
          type: string
          example: Contract 121 could not be processed
          description: Readable error message that should be shown to the user
        details:
          type: string
          example: >-
            Uncatched null point exception in testFunction() in
            /app/src/file:212
          description: Not easily readable error message that is for the developer
        txId:
          type: string
          example: c916167c94
          description: >-
            Internal transaction id. Useful for debugging. Corresponds to the
            OpenTelemetry trace ID.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT-based authentication
      x-scopes:
        api: Full access to the API
    cookieAuth:
      type: apiKey
      in: cookie
      name: connect.sid
      description: Cookie-based authentication
      x-scopes:
        api: Full access to the API

````