mHelpDesk

Supergood | mHelpDesk API

Alex Klarfeld

Alex Klarfeld

— 6 min read
Supergood | mHelpDesk API

Programmatically access mHelpDesk field service data, scheduling, and billing with a stable REST API. Supergood builds and operates production-grade, unofficial mHelpDesk integrations so your team can automate dispatch, job workflows, and back-office processes without heavy custom engineering.

Plain English: mHelpDesk is field service management software used by home service and maintenance businesses (HVAC, plumbing, electrical, cleaning, appliance repair, and more) to run operations end-to-end. An unofficial API lets you programmatically pull customers, leads, work orders, schedules, estimates, invoices, payments, photos, and technician status—and push new records or updates back into mHelpDesk.

For a tech company integrating with mHelpDesk, this means you can ingest real-time customer and job data to power scheduling dashboards, route optimization, and technician utilization; sync invoices and payments to accounting; automate estimate-to-invoice workflows from your product; or enrich your platform with job notes, attachments, signatures, and time entries. You can also push new work orders, create and update appointments, send notifications, and keep stakeholder systems (ERP/accounting, analytics, calendar) in lockstep.

What is mHelpDesk?

mHelpDesk (https://www.mhelpdesk.com/) is a cloud platform for field service management that centralizes customer CRM, job intake, scheduling and dispatch, mobile work orders, quoting, invoicing, and payments.

Core product areas include:

  • Customer & Lead Management (CRM, service locations, contact details)
  • Work Orders & Jobs (job intake, line items, parts/services, photos, signatures)
  • Scheduling & Dispatch (technician calendars, routes, appointment reminders)
  • Estimates & Invoices (quotes, approvals, conversions, billing, taxes/discounts)
  • Payments & Collections (card, check, status tracking, reconciliations)
  • Mobile Field App (offline access, status changes, notes, attachments)

Common data entities:

  • Customers, Contacts, and Service Locations
  • Leads and Opportunities
  • Work Orders/Jobs, Statuses, and Activities
  • Appointments, Technician Assignments, and Time Entries
  • Estimates/Quotes, Line Items, Taxes, Discounts
  • Invoices, Payments, and Balances
  • Products/Service Items, Price Books, and Inventory (where enabled)

The mHelpDesk Integration Challenge

Field service teams depend on mHelpDesk daily, but turning portal workflows into API-driven automation can be complex:

  • Scheduling intricacies: Technician calendars, overlapping appointments, travel buffers, and reassignment rules must be respected
  • Role-based access: Office staff, dispatchers, and technicians have different entitlements; automation must align with permissions
  • Mobile-first features: Photos, signatures, and status transitions are optimized for the app and spread across multiple views
  • Financial rigor: Estimate-to-invoice conversions, taxes/discounts, and payment states require careful state management
  • Accounting sync: Many teams rely on QuickBooks; schema normalization and timing (e.g., posting when jobs are completed) matters

How Supergood Creates mHelpDesk APIs

Supergood reverse-engineers authenticated browser flows and mobile network interactions to deliver a resilient API endpoint layer for your mHelpDesk tenant.

  • Handles username/password, SSO/OAuth, and MFA (SMS, email, TOTP) securely where enabled
  • Maintains session continuity with automated refresh and change detection
  • Normalizes responses so you can integrate once and rely on consistent objects across modules
  • Aligns with customer entitlements and role-based permissions to ensure compliant access

Use Cases

Customer & Job Data Sync

  • Mirror customers, contacts, and service locations into your CRM, ERP, or data warehouse
  • Keep work orders and statuses current for analytics and operational reporting
  • Normalize addresses, tags, and balances for multi-branch operations

Scheduling & Dispatch Automation

  • Create appointments and assign technicians from your scheduling product
  • Rebalance routes and update appointment windows in response to delays
  • Trigger customer notifications and technician mobile updates automatically

Estimates to Billing

  • Generate estimates with standardized price books and approvals
  • Convert approved estimates to invoices and push to accounting (e.g., QuickBooks)
  • Track balance due and payment state for collections and cash flow reporting

Technician Mobile Workflow

  • Attach photos, collect signatures, and update job status from your field app
  • Log time entries and materials used to drive accurate billing
  • Create follow-up work orders when issues are discovered onsite

Available Endpoints

Authentication

POST /sessions: Establish a session using credentials. Supergood manages MFA (SMS, email, TOTP) and SSO/OAuth when enabled. Returns a short-lived auth token maintained by the platform.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/sessions \
  --header 'Authorization: Basic <Base64 encoded token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "username": "[email protected]",
    "password": "<password>",
    "mfa": { "type": "totp", "code": "123456" }
  }'

Example response

{
  "authToken": "eyJhbGciOi...",
  "expiresIn": 3600,
  "user": {
    "id": "u_1fb92a",
    "name": "Dispatcher",
    "entitlements": ["customers", "work_orders", "appointments"]
  }
}

POST /sessions/refresh: Refresh an existing token to keep sessions uninterrupted.

Customers

GET /customers: List customers with filters and summary details.

Query parameters

  • status: active | inactive
  • tag: string (e.g., "VIP", "Commercial")
  • updatedFrom, updatedTo: ISO 8601 timestamps
  • page, pageSize: integers for pagination

Example response

{
  "items": [
    {
      "customerId": "cus_7a3201",
      "displayName": "Eastside Apartments",
      "primaryContact": {
        "name": "Sam Rivera",
        "email": "[email protected]",
        "phone": "+1-404-555-0134"
      },
      "billingAddress": {
        "line1": "500 Eastside Blvd",
        "city": "Atlanta",
        "region": "GA",
        "postalCode": "30312",
        "country": "US"
      },
      "defaultServiceLocation": {
        "line1": "510 Eastside Blvd",
        "city": "Atlanta",
        "region": "GA",
        "postalCode": "30312",
        "country": "US"
      },
      "tags": ["Property Manager", "VIP"],
      "balance": 0.00,
      "status": "active",
      "updatedAt": "2026-01-20T13:45:00Z"
    }
  ],
  "page": 1,
  "pageSize": 50,
  "total": 1
}

Work Orders

POST /work-orders: Create a new work order/job with line items, scheduling hints, and optional attachments.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/work-orders \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "customerId": "cus_7a3201",
    "serviceLocation": {
      "line1": "510 Eastside Blvd",
      "city": "Atlanta",
      "region": "GA",
      "postalCode": "30312",
      "country": "US"
    },
    "title": "HVAC heat pump not cycling",
    "problemDescription": "Outdoor unit intermittently shuts off; tenant reports low heat.",
    "priority": "high",
    "scheduledStart": "2026-01-23T09:00:00-05:00",
    "technicianIds": ["tech_12aa9f"],
    "serviceItems": [
      {"itemCode": "DIAG-HVAC", "description": "Diagnostic visit", "quantity": 1, "unitPrice": 125.00, "taxable": true},
      {"itemCode": "CAP-45UF", "description": "Run capacitor 45uF", "quantity": 1, "unitPrice": 39.99, "taxable": true}
    ],
    "attachments": [
      {"fileName": "tenant-photo.jpg", "uploadToken": "upl_98dc3a"}
    ],
    "customFields": {
      "unit": "A-204",
      "accessNotes": "Key at front desk"
    },
    "source": "phone",
    "referenceId": "lead-8793"
  }'

Example response

{
  "workOrderId": "wo_5c21b0",
  "number": "WO-2026-00128",
  "status": "new",
  "createdAt": "2026-01-21T09:12:33Z",
  "customerId": "cus_7a3201"
}

Appointments (Scheduling)

POST /appointments: Create an appointment on a technician’s calendar and link it to a work order.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/appointments \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "workOrderId": "wo_5c21b0",
    "technicianId": "tech_12aa9f",
    "startAt": "2026-01-23T09:00:00-05:00",
    "endAt": "2026-01-23T10:00:00-05:00",
    "timezone": "America/New_York",
    "instructions": "Call tenant 15 min prior; bring capacitor.",
    "notifyCustomer": true
  }'

Example response

{
  "appointmentId": "appt_90e412",
  "status": "scheduled",
  "workOrderId": "wo_5c21b0",
  "technicianId": "tech_12aa9f",
  "createdAt": "2026-01-21T10:03:11Z"
}

Get full API Specs →

Technical Specifications

  • Authentication: Username/password with MFA (SMS, email, TOTP) and SSO/OAuth where enabled; supports service accounts or customer-managed credentials
  • Response format: JSON with consistent resource schemas and pagination across modules
  • Rate limits: Tuned for field service throughput while honoring customer entitlements and usage controls
  • Session management: Automatic reauth and cookie/session rotation with health checks
  • Data freshness: Near real-time retrieval of customers, work orders, schedules, and financial objects
  • Security: Encrypted transport, scoped tokens, and audit logging; respects mHelpDesk role-based permissions
  • Webhooks: Optional asynchronous delivery for scheduling changes, job status updates, estimate approvals, and payments

Performance Characteristics

  • Latency: Sub-second responses for list/detail queries under normal load
  • Throughput: Designed for high-volume customer sync and job scheduling operations
  • Reliability: Retry logic, backoff, and idempotency keys minimize duplicate actions
  • Adaptation: Continuous monitoring for UI/API changes with rapid adapter updates

Getting Started

  1. Schedule Integration Assessment

Book a 30-minute session to confirm your modules, licensing, and authentication model.

  1. Supergood Builds and Validates Your API

We deliver a hardened mHelpDesk adapter tailored to your workflows and entitlements.

  1. Deploy with Monitoring

Go live with continuous monitoring and automatic adjustments as mHelpDesk evolves.

Schedule Integration Call →

Frequently Asked Questions

Q: Which mHelpDesk modules can this integration cover?

Supergood supports workflows across commonly used modules such as CRM (Customers, Leads), Jobs (Work Orders, Activities), Scheduling (Appointments, Technician Assignment), and Financials (Estimates, Invoices, Payments), subject to your licensing and entitlements. We scope coverage during integration assessment.

Q: How are MFA and SSO handled for automation?

We support username/password + MFA (SMS, email, TOTP) and can operate behind SSO/OAuth when enabled. Sessions are refreshed automatically with secure challenge handling.

Q: Can you sync invoices and payments to our accounting system?

Yes. We can normalize estimates, invoices, and payments to match your ERP/accounting schema (e.g., QuickBooks Online) and deliver updates via webhooks or polling while complying with rate and permission constraints.

Q: Are attachments and signatures supported on work orders?

Yes. We support downloading artifacts and uploading attachments via signed uploads, with checksum validation and time-limited URLs. Signatures and photos captured in the mobile app can be mirrored to your system.

Ready to automate your mHelpDesk workflows?

Supergood can have your mHelpDesk integration live in days with no ongoing engineering maintenance.

Get Started →

Read more