mHelpDesk API
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, es
What is mHelpDesk?
mHelpDesk 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
Getting Started
- Schedule Integration Assessment
Book a 30-minute session to confirm your modules, licensing, and authentication model.
- Supergood Builds and Validates Your API
We deliver a hardened mHelpDesk adapter tailored to your workflows and entitlements.
- Deploy with Monitoring
Go live with continuous monitoring and automatic adjustments as mHelpDesk evolves.
API Endpoints
Authentication
/sessionsEstablish 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.
Authentication
/sessions/refreshRefresh an existing token to keep sessions uninterrupted.
Customers
/customersList customers with filters and summary details.
Work Orders
/work-ordersCreate a new work order/job with line items, scheduling hints, and optional attachments.
Appointments (Scheduling)
/appointmentsCreate an appointment on a technician’s calendar and link it to a work order.
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
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
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
Frequently asked questions
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.
We support username/password + MFA (SMS, email, TOTP) and can operate behind SSO/OAuth when enabled. Sessions are refreshed automatically with secure challenge handling.
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.
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.