Get specific email account helpdesk settings

Retrieves helpdesk settings for a specific email account, including any account-level overrides.

What is returned:

Account information: ID, email address, display name
Helpdesk status: Whether helpdesk is enabled for this account
Account settings: If enabled, returns all account-specific settings:
- Task defaults that override workspace defaults
- Auto-reply configuration (with 3-state inheritance support)
- Assignment rules
- Any other account-level overrides

Settings inheritance: If the account has custom settings:

Non-null fields override workspace defaults
Null fields inherit from workspace defaults
The response shows the effective settings (merged defaults + overrides)

Error handling: Returns 404 if the email account is not found or doesn’t belong to the workspace.

Note: This endpoint requires the WsSettings.manageSettings permission.

GET/helpdesk/email-accounts/{accountId}/settings

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Path parameters

accountIdstringrequired

Email account ID

Responses

200Email account settings retrieved successfully

displayNamestringrequired

Display name for the email account. This is the friendly name shown in the UI and in email headers.

emailstringrequired

Email address of the account. This is the address that receives helpdesk emails.

helpdeskEnabledbooleanrequired

Whether helpdesk is currently enabled for this email account. When enabled, emails sent to this account will be automatically processed and converted to tasks. When disabled, emails are ignored.

idstringrequired

Unique identifier for the email account. Use this ID to reference the account in other API calls.

settingsobject

Account-specific helpdesk settings that override workspace defaults. Only present when helpdesk is enabled for this account. Null fields inherit from workspace defaults. If helpdesk is disabled, this field will be undefined.

401Unauthorized - Invalid or missing authentication token

403Forbidden - Insufficient API scopes or permissions

404Email account not found

Request

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

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

import requests

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

Response

{
  "displayName": "Support Team",
  "email": "support@example.com",
  "helpdeskEnabled": true,
  "id": "account-uuid-123",
  "settings": {
    "defaultReplyBody": "<p>Thank you for contacting us.</p>",
    "emailAccountId": "account-uuid-123",
    "emailAddress": "support@example.com",
    "emailDisplayName": "Support Team",
    "isEnabled": true,
    "sendDefaultReply": true,
    "taskAccountableId": null,
    "taskAssignedId": null,
    "taskPriority": "Normal",
    "taskProjectId": null,
    "taskStatusId": null,
    "taskTagsIds": null,
    "taskTypeId": "type-uuid-456"
  }
}