Supergood | FieldEdge API
Programmatically access FieldEdge field service data, dispatch workflows, and financials with a stable REST API. Supergood builds and operates production-grade, unofficial FieldEdge integrations so your team can automate field and office operations without heavy custom engineering.
Plain English: 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, payments, pricebook items, and service agreements—and push new records or updates back into FieldEdge.
For a tech company integrating with FieldEdge, this means you can ingest real-time job and dispatch data to power internal dashboards, sync invoices to accounting systems, automate maintenance plan renewals and recurring visits, build quotes from the pricebook, reconcile payments, and enrich your platform with equipment service history and technician performance. You can also create new work orders from IoT alerts or web forms, update job statuses, attach photos and signatures, and keep ERP, analytics, and payroll systems in lockstep.
What is FieldEdge?
FieldEdge (https://fieldedge.com/) 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
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
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_b15c9f",
"name": "Dispatch Lead",
"entitlements": ["customers", "work_orders", "scheduling", "agreements", "pricebook"]
}
}
POST /sessions/refresh: Refresh an existing token to keep sessions uninterrupted.
Customers
GET /customers: List customers with filters and summary details.
Query parameters
- name: string (partial match)
- phone: string
- city: string
- updatedFrom, updatedTo: ISO 8601 timestamps
- page, pageSize: integers for pagination
Example response
{
"items": [
{
"customerId": "cust_8f21a3",
"name": "Jane Smith",
"status": "active",
"primaryContact": {
"email": "[email protected]",
"phone": "+1-404-555-0199"
},
"defaultTerms": "net_30",
"primaryLocation": {
"locationId": "loc_7610ab",
"address": {
"line1": "1250 Maple Ave",
"city": "Atlanta",
"region": "GA",
"postalCode": "30312",
"country": "US"
},
"equipmentCount": 3
},
"createdAt": "2026-01-15T14:22:08Z",
"updatedAt": "2026-01-22T09:17:33Z"
}
],
"page": 1,
"pageSize": 50,
"total": 1
}
Work Orders
POST /work-orders: Create a new work order (service call) with dispatch metadata.
curl --request POST \
--url https://api.supergood.ai/integrations/<integration_id>/work-orders \
--header 'Authorization: Bearer <authToken>' \
--header 'Content-Type: application/json' \
--data '{
"customerId": "cust_8f21a3",
"serviceLocationId": "loc_7610ab",
"category": "hvac",
"priority": "high",
"source": "web_form",
"requestedBy": "Jane Smith",
"problemDescription": "No heat; thermostat reads 68, furnace not firing.",
"scheduledStart": "2026-01-24T15:00:00Z",
"scheduledEnd": "2026-01-24T17:00:00Z",
"assignedTechnicianId": "tech_52c901",
"tags": ["emergency", "warranty"],
"referenceId": "iot-alert-98765"
}'
Example response
{
"workOrderId": "wo_2d9a11",
"number": "WO-2026-001248",
"status": "scheduled",
"createdAt": "2026-01-24T10:41:12Z"
}
PATCH /work-orders/{workOrderId}/status: Update a work order's lifecycle status and timestamps.
curl --request PATCH \
--url https://api.supergood.ai/integrations/<integration_id>/work-orders/wo_2d9a11/status \
--header 'Authorization: Bearer <authToken>' \
--header 'Content-Type: application/json' \
--data '{
"newStatus": "completed",
"arrivalTime": "2026-01-24T15:12:04Z",
"startTime": "2026-01-24T15:20:00Z",
"completionTime": "2026-01-24T16:35:27Z",
"resolutionSummary": "Replaced igniter and cleaned flame sensor; system heating normally.",
"followUpRequired": false,
"attachments": [
{"fileName": "furnace_sensor.jpg", "uploadToken": "upl_9ab731"},
{"fileName": "customer_signature.png", "uploadToken": "upl_183e2b"}
]
}'
Example response
{
"workOrderId": "wo_2d9a11",
"status": "completed",
"arrivalTime": "2026-01-24T15:12:04Z",
"startTime": "2026-01-24T15:20:00Z",
"completionTime": "2026-01-24T16:35:27Z",
"updatedAt": "2026-01-24T16:36:02Z"
}
Appointments & Scheduling
GET /appointments: List scheduled appointments across technicians and date ranges.
Query parameters
- startDate, endDate: ISO 8601 dates
- technicianId: string (optional)
- status: scheduled | dispatched | in_progress | completed | canceled
- page, pageSize: integers for pagination
Example response
{
"items": [
{
"appointmentId": "appt_7f8c10",
"workOrderId": "wo_2d9a11",
"technicianId": "tech_52c901",
"scheduledStart": "2026-01-24T15:00:00Z",
"scheduledEnd": "2026-01-24T17:00:00Z",
"arrivalWindow": {
"start": "2026-01-24T15:00:00Z",
"end": "2026-01-24T17:00:00Z"
},
"status": "completed",
"serviceLocation": {
"address": {
"line1": "1250 Maple Ave",
"city": "Atlanta",
"region": "GA",
"postalCode": "30312",
"country": "US"
}
},
"summary": "HVAC no-heat call"
}
],
"page": 1,
"pageSize": 50,
"total": 1
}
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)
Performance Characteristics
- 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
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.
Frequently Asked Questions
Q: Which FieldEdge modules can this integration cover?
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.
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 ERP/accounting?
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.
Q: Do you support attachments and technician signatures?
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.
Related Integrations
Intralinks API - Programmatically access the Intralinks VDR with Supergood
Ready to automate your FieldEdge workflows?
Supergood can have your FieldEdge integration live in days with no ongoing engineering maintenance.
