v1

latestOpenAPI 3.0.02026-07-17715665.1 KB
Settings

List all settings.

get/api/settings

Query parameters

keystring
type'Integer' | 'Float' | 'String' | 'Textarea' | 'Boolean' | 'IntegerList' | 'StringList' | 'Image' | 'Radio' | 'JSON'
groupnumber
subgroupnumber

Response

All settings.

_idstring required
keystring required
valuestring required
defaultValuestring required
type'Integer' | 'Float' | 'String' | 'Textarea' | 'Boolean' | 'IntegerList' | 'StringList' | 'Image' | 'Radio' | 'JSON' required
labelstring required
descriptionstring required
groupnumber required
optionsstring required
subgroupnumber required
periodOverridableboolean required

Example response

[
  {
    "_id": "621f802b813dbdbaddeaf799",
    "key": "SETTING_KEY",
    "value": "666",
    "defaultValue": "555",
    "label": "Quantifiers Per Praise",
    "description": "How many redundant quantifications are assigned to each praise?",
    "periodOverridable": true
  }
]