Get workspace helpdesk settings

Retrieves workspace-wide helpdesk settings including default configurations and email account settings.

What is Helpdesk? Helpdesk is an automated email-to-task conversion system that transforms incoming emails into tasks. When enabled, the system automatically:

• Pulls emails from configured email accounts (IMAP, Gmail, Microsoft Graph)
• Converts emails into tasks with proper assignment, priority, and categorization
• Sends automatic replies to new senders (if configured)
• Links emails to tasks for full conversation history

What is returned:

• Workspace settings: Global helpdesk configuration including:
  • isHelpdeskEnabled: Whether helpdesk is enabled for the workspace
  • defaultSettings: Default task creation settings (project, type, status, priority, assignment)
  • defaultReplyBody: HTML template for automatic replies (supports variables like taskNumber)
  • sendDefaultReply: Whether to automatically send replies to new senders
• Email account settings: List of all email accounts with their helpdesk status:
  • Each account shows if helpdesk is enabled
  • Account-specific overrides that override workspace defaults
  • Settings include task defaults, auto-reply configuration, and assignment rules

Settings inheritance: Email accounts can override workspace defaults. When an account has its own settings:

• Non-null fields override workspace defaults
• Null fields inherit from workspace defaults
• sendDefaultReply supports 3-state inheritance: null (use default), true (enabled), false (disabled)

Note: This endpoint requires the WsSettings.manageSettings permission.

curl -X GET "https://leadtime.app/api/public/helpdesk/settings" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/helpdesk/settings", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/helpdesk/settings",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

{
  "emailAccounts": [
    {
      "defaultReplyBody": null,
      "emailAccountId": "account-uuid-123",
      "emailAddress": "support@example.com",
      "emailDisplayName": "Support Team",
      "isEnabled": true,
      "sendDefaultReply": null,
      "taskAccountableId": null,
      "taskAssignedId": null,
      "taskPriority": null,
      "taskProjectId": null,
      "taskStatusId": null,
      "taskTagsIds": null,
      "taskTypeId": "type-uuid-456"
    }
  ],
  "workspace": {
    "defaultSettings": {
      "defaultReplyBody": "<p>Thank you for contacting us.</p>",
      "sendDefaultReply": true,
      "taskAssignedId": "user-uuid-101",
      "taskPriority": "Normal",
      "taskProjectId": "project-uuid-123",
      "taskStatusId": "status-uuid-789",
      "taskTypeId": "type-uuid-456"
    },
    "isHelpdeskEnabled": true
  }
}