Skip to main content
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"
  }
]

Authorizations

​
Authorization
string
header
required

JWT-based authentication

Query Parameters

​
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

Response

List of client-specific configruation settings.

​
name
string
Example:

"ticketingSystem"

​
category
string
Example:

"email"

​
group
string | null
Example:

"Generic E-Mail Settings"

​
label
string
Example:

"Ticketing system in use"

​
description
string
Example:

"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

Available options:
text,
date,
radio,
number,
integer,
checkbox,
textarea,
select,
json,
executor,
executors,
multiselect
Example:

"select"

​
config
object

Additional configuration properties that are dependant on type or rarely used

​
value
Example:

"internal"

​
defaultValue
Example:

"internal"