Supergood | FieldAware API
Programmatically access FieldAware field service data, schedules, and job artifacts with a stable REST API. Supergood builds and operates production-grade, unofficial FieldAware integrations so your team can automate field and back-office workflows without heavy custom engineering.
Plain English: FieldAware is field service management software that helps service companies schedule and dispatch technicians, manage work orders, track assets and maintenance, capture time and materials, and generate quotes and invoices via a mobile-first app. An unofficial API lets you pull customers, sites, assets, and work orders; track technician status; retrieve forms, photos, and signatures; and push scheduling updates, job outcomes, and invoices back into FieldAware.
For a tech company integrating with FieldAware, this means you can sync customers and work orders into your platform, power live dispatch boards, automate closeout and billing flows, or pipe mobile forms and attachments into your analytics or compliance systems. You can also push new jobs from your CRM, schedule the right technician based on skills and SLA windows, and update downstream systems (ERP, inventory, fleet) in near real time.
What is FieldAware?
FieldAware (https://www.fieldaware.com/) is a cloud platform for field service management used by service contractors and operations teams to coordinate work from call intake to invoicing. It centralizes scheduling and dispatch, work order execution, asset service history, mobile data capture, and time and materials tracking.
Core product areas include:
- Work Orders & Scheduling: job creation, calendars, route planning, dispatch, status tracking
- Customers, Sites & Contacts: account records, service locations, on-site contacts, SLAs
- Assets & Maintenance: equipment inventories, service history, preventive maintenance plans
- Mobile Forms & Attachments: checklists, custom forms, photos, notes, and electronic signatures
- Time & Materials: technician time, parts and consumables, price books
- Quotes & Invoicing: estimates, on-site approvals, invoice generation and exports
Common data entities:
- Customers, Sites, and Contacts
- Work Orders, Tasks, and Statuses
- Technicians, Teams, and Skills
- Assets/Equipment, Service History, and Maintenance Plans
- Time Entries and Materials/Parts Used
- Forms/Checklists, Photos, and Signatures
- Quotes, Invoices, and Line Items
The FieldAware Integration Challenge
Turning a mobile-first field service workflow into API-driven automation isn’t trivial:
- Role- and team-based permissions: dispatcher, technician, and manager views differ; access must reflect entitlements
- Scheduling complexity: overlapping calendars, skills, SLA windows, travel time, and reschedules
- Offline/mobile behavior: jobs may sync in batches; forms and photos arrive asynchronously
- Custom forms and fields: each tenant has tailored checklists, price books, and job types
- Attachments at scale: photos, PDFs, and signatures need reliable upload/download and integrity checks
- Enterprise security: SSO/MFA and session lifecycles must be handled safely for headless automation
How Supergood Creates FieldAware APIs
Supergood reverse-engineers authenticated browser and mobile flows to deliver a resilient API endpoint layer for your FieldAware 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
Work Order Data Sync
- Mirror customers, sites, and work orders into your internal systems
- Keep job metadata and statuses current for dashboards and SLAs
- Normalize addresses, priorities, and custom fields for multi-tenant operations
Scheduling & Dispatch Automation
- Create and schedule jobs from CRM, IoT alerts, or customer portals
- Auto-assign technicians based on skills, location, and SLA due times
- Trigger notifications and reschedules when conditions change
Job Closeout and Billing
- Capture time and materials programmatically and close jobs upon approval
- Generate and sync invoices to your ERP (e.g., QuickBooks, NetSuite)
- Attach photos, forms, and signatures to support compliance and audits
Asset & Preventive Maintenance
- Keep asset records and service history in sync with your CMMS or EAM
- Generate PM work orders on cadence and track completion
- Alert on overdue maintenance and parts consumption
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_4c9bd2",
"name": "Dispatch Lead",
"entitlements": ["workOrders", "customers", "scheduling", "assets", "forms"]
}
}
POST /sessions/refresh: Refresh an existing token to keep sessions uninterrupted.
Work Orders
GET /work-orders: List work orders with filters and summary details.
Query parameters
- customerId: string
- siteId: string
- technicianId: string
- status: new | scheduled | en_route | on_site | paused | completed | canceled
- scheduledFrom, scheduledTo: ISO 8601 timestamps
- updatedFrom, updatedTo: ISO 8601 timestamps
- page, pageSize: integers for pagination
Example response
{
"items": [
{
"workOrderId": "wo_91f2e7",
"number": "WO-2026-01428",
"status": "scheduled",
"priority": "high",
"jobType": "preventive_maintenance",
"customerId": "cust_20a4b1",
"siteId": "site_778c10",
"scheduledWindow": {
"start": "2026-02-03T14:00:00Z",
"end": "2026-02-03T16:00:00Z"
},
"slaDueAt": "2026-02-03T20:00:00Z",
"assignedTechnicians": [
{ "technicianId": "tech_12ab44", "role": "primary" }
],
"contact": {
"name": "Pat Morgan",
"phone": "+1-555-0102",
"email": "[email protected]"
},
"location": {
"line1": "1250 Industrial Blvd",
"city": "Dallas",
"region": "TX",
"postalCode": "75201",
"country": "US"
},
"updatedAt": "2026-01-22T09:45:11Z"
}
],
"page": 1,
"pageSize": 50,
"total": 1
}
Dispatch
POST /work-orders/{workOrderId}/dispatch: Assign a technician and schedule a work order.
curl --request POST \
--url https://api.supergood.ai/integrations/<integration_id>/work-orders/wo_91f2e7/dispatch \
--header 'Authorization: Bearer <authToken>' \
--header 'Content-Type: application/json' \
--data '{
"assignments": [
{ "technicianId": "tech_12ab44", "role": "primary" }
],
"scheduledWindow": {
"start": "2026-02-03T14:00:00Z",
"end": "2026-02-03T16:00:00Z"
},
"notifyTechnicians": true,
"notificationMessage": "New PM at Acme Dallas, arrive by 2 PM",
"constraints": {
"requiredSkills": ["hvac_cert"],
"maxTravelMinutes": 45
}
}'
Example response
{
"workOrderId": "wo_91f2e7",
"status": "scheduled",
"scheduledWindow": {
"start": "2026-02-03T14:00:00Z",
"end": "2026-02-03T16:00:00Z"
},
"assignedTechnicians": [
{ "technicianId": "tech_12ab44", "role": "primary" }
],
"notifications": [
{ "technicianId": "tech_12ab44", "channel": "push", "sentAt": "2026-01-22T10:02:33Z" }
]
}
Job Completion
POST /work-orders/{workOrderId}/complete: Close a work order, capturing labor, parts, forms, photos, and signatures.
curl --request POST \
--url https://api.supergood.ai/integrations/<integration_id>/work-orders/wo_91f2e7/complete \
--header 'Authorization: Bearer <authToken>' \
--header 'Content-Type: application/json' \
--data '{
"resolutionNotes": "Replaced condenser fan motor and verified amperage.",
"labor": [
{
"technicianId": "tech_12ab44",
"start": "2026-02-03T14:10:00Z",
"end": "2026-02-03T15:25:00Z",
"hours": 1.25,
"billable": true
}
],
"materials": [
{ "partNumber": "CFM-200", "description": "Condenser Fan Motor", "quantity": 1, "unitCost": 185.00 }
],
"formsSubmitted": [
{ "formType": "PM_Checklist_v3", "submissionId": "formsub_7f2210" }
],
"photos": [
{ "fileName": "before.jpg", "uploadToken": "upl_bef_9931" },
{ "fileName": "after.jpg", "uploadToken": "upl_aft_0032" }
],
"customerSignature": {
"signerName": "Pat Morgan",
"signedAt": "2026-02-03T15:27:10Z",
"uploadToken": "upl_sig_1122"
},
"invoice": {
"create": true,
"terms": "Due Upon Receipt",
"referenceNumber": "INV-2026-01428"
}
}'
Example response
{
"workOrderId": "wo_91f2e7",
"status": "completed",
"completedAt": "2026-02-03T15:28:00Z",
"totals": {
"laborHours": 1.25,
"materials": 185.0,
"tax": 15.67,
"grandTotal": 350.67
},
"invoiceId": "inv_5f2209"
}
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 work orders, customers, assets, and mobile artifacts
- Security: Encrypted transport, scoped tokens, and audit logging; respects FieldAware role-based permissions
- Webhooks: Optional asynchronous delivery for long-running workflows (e.g., job completion approvals, invoice posting)
Performance Characteristics
- Latency: Sub-second responses for list/detail queries under normal load
- Throughput: Designed for high-volume work order sync and dispatch operations
- 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 FieldAware adapter tailored to your workflows and entitlements.
- Deploy with Monitoring
Go live with continuous monitoring and automatic adjustments as FieldAware evolves.
Frequently Asked Questions
Q: Which FieldAware modules can this integration cover?
Supergood supports workflows across commonly used areas such as Work Orders & Scheduling, Customers & Sites, Assets & Preventive Maintenance, Mobile Forms & Attachments, and Time & Materials, 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 work orders to our ERP?
Yes. We can normalize work orders, time, materials, and invoices to match your ERP schema (e.g., QuickBooks, NetSuite) and deliver updates via webhooks or polling while complying with rate and permission constraints.
Q: Are photos, forms, and signatures supported?
Yes. We support downloading artifacts and uploading attachments via signed uploads, with checksum validation and time-limited URLs.
Q: Can dispatch respect skills, territories, and SLA windows?
We can enforce required skills, territories, and SLA due times during assignment and rescheduling, and we expose scheduling feedback for conflicts.
Related Integrations
Intralinks API - Programmatically access the Intralinks VDR with Supergood
Ready to automate your FieldAware workflows?
Supergood can have your FieldAware integration live in days with no ongoing engineering maintenance.
