admin

Read Company Settings Admin

GET

/api/admin/{company_name}

curl --request GET \
  --url '/api/admin/{company_name}' \
  --header 'Authorization: Bearer <token>'

{
  "disabled": false,
  "email_dpa": "jsmith@example.com",
  "feature_settings": {
    "AGENTS_ENABLED": true,
    "ANALYTICS_ENABLED": true,
    "CHAIN_TEMPLATE_ENABLED": true,
    "CUSTOM_FIELDS_ENABLED": true,
    "CUSTOM_THEME_ENABLED": true,
    "DPA_SIGNED": true,
    "EXTERNAL_LINKS_ENABLED": true,
    "GLOBAL_SEARCH_ENABLED": true,
    "INFERENCE_ENABLED": true,
    "INVEST_CALCULATOR_ENABLED": true,
    "LANGUAGES_ENABLED": "all",
    "LANGUAGES_MAXIMUM": 123,
    "LOCAL_DIAGNOSER_ENABLED": true,
    "MAIL_TO": [
      "jsmith@example.com"
    ],
    "OFFLINE_MODE_ENABLED": true,
    "QUINN_AUTO_MODE_ENABLED": true,
    "QUINN_CREDIT_LIMIT_COMPANY": 123,
    "QUINN_DICTATE_ENABLED": true,
    "QUINN_ENABLED": true,
    "QUINN_HEATMAP_ENABLED": true,
    "QUINN_TEMPLATE_QUALITY_CHECK_ENABLED": true,
    "QUINN_VIDEO_ENABLED": true,
    "QUINN_VOICE_ENABLED": true,
    "RESTRICTED_OPERATOR_ENABLED": true,
    "ROUTINES_ENABLED": true,
    "SERVICE_HISTORY_ENABLED": true,
    "SHARE_LINKS_ENABLED": true,
    "SYMPTOM_GROUPS_ENABLED": true,
    "TEMPLATE_VARIANTS_ENABLED": true,
    "TICKETS_ENABLED": true,
    "TRANSLATION_ENABLED": true
  },
  "language_default": "en",
  "languages": [
    "de",
    "en"
  ],
  "legal_name": "<string>",
  "name": "",
  "owner_name": "<string>",
  "plan_type": "trial"
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

company_namestringrequired

Response

Successful Response

disabledboolean | nulldefault:falserequired

email_dpastring | nullrequired

feature_settingsobjectrequired

FeatureSettingsUpdateSuperAdmin.model_fields.keys() == FeatureSettings.model_fields.keys() - {"ROUTINES_ENABLED", "SERVICE_HISTORY_ENABLED", "TRANSLATION_ENABLED", "LANGUAGES_ENABLED", "MAIL_TO", "QUINN_AUTO_MODE_ENABLED"} True

Show child attributes

language_defaultenum<string>required

Available options: en, de, fr, es, it, pt, nl, pl, cs, da, sv, fi, nb, et, lt, lv, sk, sl, bg, ru, uk, el, tr, hu, ja, ko, zh, id

languagesenum<string>[]default:["de","en"]required

legal_namestringrequired

namestringdefault:required

owner_namestringrequired

plan_typeenum<string>default:trialrequired

Available options: trial, paid, internal