FieldEdge API
FieldEdge is field service management software used by HVAC, plumbing, electrical, and home service contractors to run the business end-to-end. An unofficial API lets you pull customers and service locations, equipment history, work orders and schedules, estimates and invoices, paymen
What is FieldEdge?
FieldEdge is a cloud platform for field service management that centralizes customer records, scheduling/dispatch, mobile technician workflows, pricing/estimates, invoicing and payments, and long-term service agreements. Contractors use FieldEdge to book calls, dispatch technicians, track work orders, manage equipment at service locations, maintain pricebooks, process invoices and payments, and sync with accounting systems like QuickBooks.
Core product areas include:
- Customer & Location Management (e.g., contacts, addresses, installed equipment, service history)
- Dispatch & Scheduling (e.g., calendars, route planning, arrival windows, status tracking)
- Work Orders & Mobile (e.g., notes, photos, signatures, time-on-job, parts and tasks)
- Estimates, Invoices & Payments (e.g., pricebook items, proposals, tax, surcharges, financing)
- Service Agreements (e.g., plan terms, covered equipment, recurring visits, renewals)
- Accounting & Reporting (e.g., QuickBooks sync, job costing, technician performance)
Common data entities:
- Customers, Contacts, and Users (technicians, dispatchers)
- Service Locations and Installed Equipment
- Work Orders/Jobs, Appointments, and Status Events
- Estimates, Invoices, Line Items, Taxes, and Payments
- Pricebook Items (tasks, parts), Categories, and Pricing Rules
- Service Agreements/Contracts, Visits, and Renewal Terms
The FieldEdge Integration Challenge
Field service teams live in FieldEdge, but turning portal-driven workflows into API automation introduces complexities:
- Dispatch-first UX: Drag-and-drop boards, calendars, and mobile status changes are optimized for the app and scattered across views/exports
- Entitlements & roles: Office vs. field permissions, service agreement access, and pricebook visibility vary by role and must be respected
- Accounting rigor: QuickBooks sync, taxes, classes, and invoice states require careful mapping and idempotency
- Recurring plans: Service agreements drive scheduled visits and renewals with distinct rules and exceptions
- Mobile artifacts: Photos, signatures, and offline sync introduce attachment handling, retries, and conflict resolution
How Supergood Creates FieldEdge APIs
Supergood reverse-engineers authenticated browser and mobile flows to deliver a resilient API endpoint layer for your FieldEdge tenant.
- Handles username/password, SSO/OAuth, and MFA (SMS, email, TOTP) securely
- 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 FieldEdge adapter tailored to your workflows and entitlements.
- Deploy with Monitoring
Go live with continuous monitoring and automatic adjustments as FieldEdge 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 (service call) with dispatch metadata.
Work Orders
/work-orders/{workOrderId}/statusUpdate a work order's lifecycle status and timestamps.
Appointments & Scheduling
/appointmentsList scheduled appointments across technicians and date ranges.
Use Cases
Jobs & Dispatch Sync
- Mirror customers, locations, technicians, and work orders into your internal systems - Keep calendars and job boards current for live operational dashboards - Normalize statuses and timestamps for analytics and SLA tracking
Maintenance Plans & Recurring Visits
- Pull service agreements and scheduled visits to automate recurring maintenance - Trigger renewals, notify customers, and track covered equipment - Coordinate seasonal tune-ups and capacity planning
Accounting & Payments
- Generate invoices with pricebook items and taxes; reconcile payments - Sync invoice and payment data to ERP/accounting (e.g., QuickBooks) - Track job costing and technician performance for profitability analysis
Equipment & Service History
- Ingest installed equipment details, age, and service history - Enrich with IoT telemetry to auto-create work orders on alerts - Attach photos, documents, and technician notes for full asset records
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 enterprise 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 agreements
Security
Encrypted transport, scoped tokens, and audit logging; respects FieldEdge role-based permissions
Webhooks
Optional asynchronous delivery for long-running workflows (e.g., recurring visit scheduling, invoice payments)
Latency
Sub-second responses for list/detail queries under normal load
Throughput
Designed for high-volume job and schedule sync with invoice processing
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 Customers & Locations, Dispatch/Scheduling, Work Orders & Mobile, Service Agreements, Pricebook, and 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 normalize invoices, line items, taxes, and payments to match your ERP/accounting schema (e.g., QuickBooks) 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, including photos and signatures captured in the field.