Zum Hauptinhalt springen
GET
/
settings
Get settings of a client
curl --request GET \
  --url https://demo.enneo.ai/api/mind/settings \
  --header 'Authorization: Bearer <token>'
[
  {
    "name": "ticketingSystem",
    "category": "email",
    "group": "Generic E-Mail Settings",
    "label": "Ticketing system in use",
    "description": "Enneo supports multiple ticketing systems. Please select one.",
    "type": "select",
    "config": null,
    "value": "internal",
    "defaultValue": "internal"
  }
]

Autorisierungen

Authorization
string
header
erforderlich

JWT-based authentication

Abfrageparameter

filterByName
string

Filter by name of the setting

filterByUsedBy
string

Filter by which module uses the setting

filterByCategory
string

Filter by category of the setting

showSecrets
boolean

Whether to show secrets in the result

Antwort

List of client-specific configruation settings.

name
string
Beispiel:

"ticketingSystem"

category
string
Beispiel:

"email"

group
string | null
Beispiel:

"Generic E-Mail Settings"

label
string
Beispiel:

"Ticketing system in use"

description
string
Beispiel:

"Enneo supports multiple ticketing systems. Please select one."

type
enum<string>

Format in which the FE should render this setting. Follows the enneo standard dynamic intent form options specified in Notion

Verfügbare Optionen:
text,
date,
radio,
number,
integer,
checkbox,
textarea,
select,
json,
executor,
executors,
multiselect
Beispiel:

"select"

config
object

Additional configuration properties that are dependant on type or rarely used

value
Beispiel:

"internal"

defaultValue
Beispiel:

"internal"