Skip to content
Leadtime
English
Esc
navigateopen⌘Jpreview

Get organization helpdesk settings

Retrieves organization-specific helpdesk settings for a given organization.

What is Organization Helpdesk? Organizations can have their own helpdesk settings that override workspace defaults. This allows different organizations to have different task routing, priorities, and auto-reply configurations when emails are sent to the same helpdesk email account.

Settings priority (highest to lowest):

  1. Organization settings with mode=‘all’: Override everything for all senders
  2. Organization settings for member: Apply when sender is an organization member (mode=‘onlyMembers’)
  3. Workspace email account settings: Account-specific overrides at workspace level
  4. Workspace defaults: Base configuration for all helpdesk operations

What is returned:

  • Organization settings: Organization-level configuration including:
    • Organization ID and name
    • Email account settings with organization-specific overrides
    • Organization mode (onlyMembers or all)
    • Task defaults, auto-reply configuration, and assignment rules
  • Email account settings: List of email accounts with organization-level settings:
    • Each account shows organization-specific overrides
    • Includes effective defaults (merged from workspace + organization settings)
    • Shows which settings override workspace defaults

Organization modes:

  • onlyMembers: Settings apply only when the email sender is a member of this organization
  • all: Settings apply to ALL emails sent to the account, regardless of sender

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

Note: This endpoint requires the Organizations.edit permission.

GET/helpdesk/organizations/{organizationId}/settings
Authorization
AuthorizationOAuth2 access token · headerrequired
Scopes:api:read
or
AuthorizationBearer token (JWT) · headerrequired
Path parameters
organizationIdstringrequired
Organization ID
Responses
200Organization helpdesk settings retrieved successfully
emailAccountsobject[]required
List of email accounts with organization-specific helpdesk settings. Each account shows organization-level overrides and includes `effectiveDefaults` which shows the final merged settings (organization + workspace defaults). Organization settings override workspace defaults when emails are processed from organization members (or all senders if mode='all').
settingsobjectrequired
Organization-level helpdesk settings. These settings allow organizations to override workspace defaults for their email routing. Organization settings have higher priority than workspace defaults and can apply to all emails or only emails from organization members.
401Unauthorized - Invalid or missing authentication token
403Forbidden - Insufficient API scopes or permissions
404Organization not found
Request
curl -X GET "https://leadtime.app/api/public/helpdesk/organizations/org-uuid-123/settings" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Response
{
  "emailAccounts": [
    {
      "addressContains": "acme.com",
      "defaultReplyBody": null,
      "effectiveDefaults": {
        "addressContains": "acme.com",
        "defaultReplyBody": "<p>Default reply</p>",
        "sendDefaultReply": true,
        "taskPriority": "Normal",
        "taskProjectId": "project-uuid-123",
        "taskStatusId": "status-uuid-789",
        "taskTypeId": "type-uuid-456"
      },
      "emailAccountId": "account-uuid-123",
      "emailAddress": "support@example.com",
      "emailDisplayName": "Support Team",
      "isEnabled": true,
      "organizationMode": "onlyMembers",
      "sendDefaultReply": null,
      "taskAccountableId": null,
      "taskAssignedId": null,
      "taskPriority": null,
      "taskProjectId": null,
      "taskStatusId": null,
      "taskTagsIds": null,
      "taskTypeId": null
    }
  ],
  "settings": {
    "emailAccountSettings": [],
    "organizationId": "org-uuid-123",
    "organizationName": "Acme Corp"
  }
}