Get email accounts with helpdesk status

Retrieves all email accounts in the workspace with their helpdesk enabled status and settings.

What is returned: A list of all email accounts configured in the workspace, each containing:

Account identification: ID, email address, and display name
Helpdesk status: Whether helpdesk is enabled for this account
Account settings: If enabled, includes all account-specific helpdesk settings:
- Task defaults (project, type, status, priority, assignment)
- Auto-reply configuration
- Any overrides that differ from workspace defaults

Use cases:

View which email accounts have helpdesk enabled
Check account-specific settings and overrides
Identify accounts that are using workspace defaults vs. custom settings

Note: This endpoint requires the WsSettings.manageSettings permission.

GET/helpdesk/email-accounts

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Responses

200Email accounts retrieved successfully

Array of EmailAccountHelpdeskStatusResponse

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

Request

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

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

import requests

response = requests.get(
    "https://leadtime.app/api/public/helpdesk/email-accounts",
    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"
    }
  }
]