Skip to main content
The Configuration API provides access to helpdesk settings and system configuration.

​
Get Configuration

Retrieve current helpdesk system configuration. 
helpdesk.api.config.get_config()
From helpdesk/api/config.py:5 - Guest-accessible endpoint for public configuration.

​
Parameters

No parameters required.

​
Response

Returns HD Settings configuration: 
{
  "brand_name": "Acme Support",
  "brand_logo": "/files/logo.png",
  "favicon": "/assets/helpdesk/desk/favicon.svg",
  "prefer_knowledge_base": true,
  "setup_complete": true,
  "skip_email_workflow": false,
  "is_feedback_mandatory": false,
  "restrict_tickets_by_agent_group": true,
  "assign_within_team": false,
  "disable_saved_replies_global_scope": false,
  "enable_comment_reactions": true
}
​
brand_name
string
Organization or brand name displayed in the portal
Path to brand logo image file
​
favicon
string
Path to favicon (falls back to Website Settings or default)
​
prefer_knowledge_base
boolean
Whether to show knowledge base before ticket creation
​
setup_complete
boolean
Whether initial setup wizard has been completed
​
skip_email_workflow
boolean
Skip sending email notifications
​
is_feedback_mandatory
boolean
Require feedback before closing tickets
​
restrict_tickets_by_agent_group
boolean
Limit ticket visibility to assigned teams
​
assign_within_team
boolean
Only allow assignment to team members
​
disable_saved_replies_global_scope
boolean
Disable global saved replies (team/personal only)
​
enable_comment_reactions
boolean
Allow emoji reactions on comments

​
Example

// No authentication required for public config
fetch("https://your-site.frappe.cloud/api/method/helpdesk.api.config.get_config")
  .then(res => res.json())
  .then(data => {
    const config = data.message;
    console.log(`Brand: ${config.brand_name}`);
    console.log(`KB Preferred: ${config.prefer_knowledge_base}`);
  });

​
Get Translations

Retrieve translated strings for the user’s language. 
helpdesk.api.general.get_translations()
From helpdesk/api/general.py:6 - Returns all translations for current user’s language.

​
Response

Returns translation dictionary: 
{
  "Ticket": "Ticket",
  "Status": "Estado",
  "Priority": "Prioridad",
  "Open": "Abierto"
}

​
Language Detection

  1. Uses authenticated user’s language preference
  2. Falls back to System Settings language
  3. Defaults to English if not specified

​
Example

import requests

response = requests.get(
    "https://your-site.frappe.cloud/api/method/helpdesk.api.general.get_translations",
    headers={"Authorization": f"token {api_key}:{api_secret}"}
)

translations = response.json()["message"]
status_label = translations.get("Status", "Status")

​
Get Current User

Retrieve information about the authenticated user. 
helpdesk.api.auth.get_user()
From helpdesk/api/auth.py:8 - Returns current session user details.

​
Response

See Authentication documentation for response details.

​
System Settings

These settings are configured in HD Settings DocType and control system behavior:

​
Branding

  • Brand name and logo
  • Favicon customization

​
Workflow

  • Email notifications
  • Feedback requirements
  • Knowledge base preference

​
Permissions

  • Team-based restrictions
  • Assignment rules

​
Features

  • Comment reactions
  • Saved replies scope

​
Usage Notes

Configuration settings are cached and updated when HD Settings is modified.
The get_config endpoint is publicly accessible. Do not include sensitive information in these settings.

Settings Configuration

Learn how to configure system settings

Authentication

User authentication and sessions

Build docs developers (and LLMs) love

Get started for freeTalk to us