System Settings

This endpoint let you access the system settings which are used in the front-end, like branding preferences, chat settings, etc.

The settings object

  • logo string

    The main logo of the application. Should be compatible with light backgrounds.

  • logo_inverse string

    The logo of the application for dark backgrounds.

  • custom_css_file string

    Path to a custom CSS file.

The settings object

{
  "data": {
    "branding": {
      "logo": "http://www.yourdomain.com/svg/logo.svg",
      "logo_inverse": "http://www.yourdomain.com/svg/logo-inverse.svg",
      "custom_css_file": null
    }
  }
}

List all settings

Sample request

curl https://www.yourdomain.com/api/v1/system/settings \
  -H "Accept: application/json" \
  -G

Sample successful response

{
  "data": {
    "branding": {
      "logo": "http://www.yourdomain.com/svg/logo.svg",
      "logo_inverse": "http://www.yourdomain.com/svg/logo-inverse.svg",
      "custom_css_file": null
    }
  }
}