Supergood | IFS Field Service Management API

Supergood | IFS Field Service Management API

Programmatically access IFS Field Service Management data and workflows—work orders, scheduling/dispatch, assets, contracts, and field debriefs—with a stable REST API. Supergood builds and operates production-grade, unofficial IFS FSM integrations so your team can automate field and back-office operations without heavy custom engineering.

Plain English: IFS Field Service Management is software used by service organizations to plan work, dispatch technicians, manage assets and contracts, track parts and inventory, and complete jobs in the field with mobile apps. An unofficial API lets you pull service requests, work orders, appointments, technician schedules, installed-base assets, service contract entitlements, and parts usage—and push new work orders, dispatch updates, debriefs (labor/parts/expenses), and status changes back into IFS.

For a tech company integrating with IFS FSM, this means you can ingest real-time work order and asset data to power operations dashboards, trigger automated dispatch from your product, sync debriefs and parts usage to ERP/accounting, or enrich your platform with appointment and SLA status. You can also push new service requests from IoT alerts, attach photos and signatures, and keep stakeholder systems (ERP, analytics, inventory, scheduling) in lockstep.

What is IFS Field Service Management?

IFS Field Service Management (https://www.ifs.com/solutions/service-management/field-service-management) is a cloud platform that enables end-to-end service operations for organizations with mobile workforces. Teams use IFS FSM to create and manage work orders, optimize schedules and routes, enforce service-level agreements (SLAs), track installed-base assets and warranties, process field debriefs (labor/parts/expenses), and coordinate parts logistics and returns.

Core product areas include:

  • Work Order Management (service requests, tasks, status workflows)
  • Scheduling & Dispatch (appointments, routes, crew assignment, optimization)
  • Installed Base & Asset Service (equipment records, meters, warranties)
  • Contracts & Entitlements (service contracts, SLAs, coverage windows, pricing)
  • Field Debrief & Billing (labor time, parts usage, expenses, approvals)
  • Parts & Inventory (warehouses, van stock, reservations, RMAs/returns)

Common data entities:

  • Customers, Users/Technicians, Teams, Permissions
  • Service Requests and Work Orders (metadata, priorities, SLAs, statuses)
  • Appointments and Schedules (windows, ETA, route/sequence, assignment)
  • Assets/Installed Base (serial numbers, models, locations, meters)
  • Service Contracts, Warranties, Entitlements (coverage, response/resolution targets)
  • Debriefs (labor entries, parts lines, expenses), Attachments, Signatures
  • Warehouses, Parts, Stock Levels, Transfers, Returns (RMAs)

The IFS Field Service Management Integration Challenge

Field service teams rely on IFS FSM daily, but turning portal-first workflows into API-driven automation is non-trivial:

  • Module-specific interfaces: Work Orders, Dispatch, Contracts, and Inventory each have distinct data models and permissions
  • Enterprise security: SSO/MFA and role-based access control complicate headless automation across mobile and web contexts
  • Scheduling complexity: Optimizers, appointment windows, crew skills, and travel constraints must be respected programmatically
  • Offline/mobile realities: Field clients sync intermittently; integrations need resilient session management and conflict handling
  • Entitlements & SLAs: Contract coverage, warranty rules, and approval chains require careful enforcement in automated flows

How Supergood Creates IFS FSM APIs

Supergood reverse-engineers authenticated browser flows and network interactions to deliver a resilient API endpoint layer for your IFS FSM 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 Sync and Dispatch

  • Mirror service requests and work orders into your internal systems
  • Auto-create work orders from IoT alerts, CRM cases, or customer portals
  • Assign technicians and create appointments based on skills, location, and windows

Technician Scheduling and Route Optimization

  • Pull schedules and appointments to build routing dashboards
  • Trigger dispatch changes (reassign, reschedule) when upstream signals change
  • Track ETA, arrival, and job progress for customer notifications

Asset and Contract Entitlements

  • Ingest installed-base assets and coverage details to validate work
  • Enforce SLAs and warranty rules in your workflow
  • Maintain meter readings and service history for predictive maintenance

Parts, Inventory, and Returns

  • Record parts usage from debrief for ERP sync and stock adjustments
  • Create RMAs when returns or exchanges are needed
  • Reconcile van stock and warehouse movements with accounting

Field Debrief and Billing

  • Capture labor time, parts lines, and expenses programmatically
  • Attach photos, signatures, and notes for audit trails
  • Push approvals and status changes to trigger billing events

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_9182f3",
    "name": "Dispatcher",
    "entitlements": ["work_orders", "dispatch", "assets", "contracts"]
  }
}

Work Orders

GET /work-orders: List work orders with filters and summary details.

Query parameters

  • customerId: string
  • status: new | scheduled | en_route | in_progress | completed | canceled
  • priority: low | normal | high | critical
  • scheduledFrom, scheduledTo: ISO 8601 timestamps
  • updatedFrom, updatedTo: ISO 8601 timestamps
  • page, pageSize: integers for pagination

Example response

{
  "items": [
    {
      "workOrderId": "wo_5f31b0",
      "externalRef": "CASE-10248",
      "subject": "HVAC compressor not cooling",
      "status": "scheduled",
      "priority": "high",
      "customerId": "cust_2217",
      "siteId": "site_409",
      "location": {
        "line1": "1200 Industrial Ave",
        "city": "Houston",
        "region": "TX",
        "postalCode": "77002",
        "country": "US"
      },
      "asset": {
        "assetId": "asset_9873",
        "serialNumber": "SN-AC-44321",
        "model": "ACX-5000"
      },
      "sla": {
        "responseTargetHours": 4,
        "resolutionTargetHours": 24,
        "contractId": "ctr_3021"
      },
      "scheduledWindow": {
        "start": "2026-01-24T14:00:00Z",
        "end": "2026-01-24T18:00:00Z"
      },
      "assignedTechnicianId": "tech_77a1c",
      "updatedAt": "2026-01-23T19:12:00Z"
    }
  ],
  "page": 1,
  "pageSize": 50,
  "total": 1
}

POST /work-orders: Create a new work order with asset and contract context.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/work-orders \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "subject": "Replace failed pump motor",
    "description": "Unit overheats under load; motor winding resistance out of spec.",
    "customerId": "cust_9820",
    "siteId": "site_140",
    "assetId": "asset_6112",
    "problemCode": "PUMP_MOTOR_FAIL",
    "priority": "critical",
    "requestedBy": {
      "name": "Facility Manager",
      "email": "[email protected]",
      "phone": "+1-555-0100"
    },
    "serviceContractId": "ctr_4582",
    "sla": { "responseTargetHours": 2, "resolutionTargetHours": 12 },
    "dueDate": "2026-01-25",
    "attachments": [
      {"fileName": "diagnostic_report.pdf", "uploadToken": "upl_8851c9"}
    ]
  }'

Example response

{
  "workOrderId": "wo_7cb2e9",
  "status": "new",
  "createdAt": "2026-01-24T09:33:12Z"
}

Dispatch

POST /work-orders/{workOrderId}/dispatch: Assign a technician and create an appointment within a defined window.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/work-orders/wo_7cb2e9/dispatch \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "technicianId": "tech_45bf90",
    "window": { "start": "2026-01-24T13:00:00Z", "end": "2026-01-24T15:00:00Z" },
    "routeId": "route_20260124_tech_45bf90",
    "notes": "Critical contract; prioritize arrival.",
    "notifyCustomer": true
  }'

Example response

{
  "appointmentId": "appt_31c552",
  "status": "scheduled",
  "eta": "2026-01-24T13:45:00Z",
  "workOrderId": "wo_7cb2e9",
  "technicianId": "tech_45bf90"
}

Field Debrief

POST /work-orders/{workOrderId}/debrief: Submit labor, parts, expenses, resolution notes, and signatures.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/work-orders/wo_7cb2e9/debrief \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "labor": [
      {"technicianId": "tech_45bf90", "start": "2026-01-24T13:10:00Z", "end": "2026-01-24T15:40:00Z", "laborCode": "REG", "hours": 2.5}
    ],
    "parts": [
      {"partNumber": "PM-4001", "description": "Pump Motor 5HP", "quantity": 1, "unitPrice": 850.00}
    ],
    "expenses": [
      {"type": "travel", "amount": 25.00, "currency": "USD"}
    ],
    "resolution": {
      "summary": "Motor replaced and tested. Temperature within spec.",
      "problemCode": "PUMP_MOTOR_FAIL",
      "resolutionCode": "REPLACEMENT"
    },
    "attachments": [
      {"fileName": "installed_motor.jpg", "uploadToken": "upl_3a4c21"}
    ],
    "customerSignature": {"name": "A. Lopez", "signedAt": "2026-01-24T15:42:12Z", "signatureToken": "sig_88d920"},
    "setStatus": "completed"
  }'

Example response

{
  "debriefId": "dbf_72f11a",
  "workOrderId": "wo_7cb2e9",
  "status": "completed",
  "totalLaborHours": 2.5,
  "totalParts": 1,
  "totalAmount": 875.00,
  "updatedAt": "2026-01-24T15:45:03Z"
}

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 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, schedules, assets, and contract objects
  • Security: Encrypted transport, scoped tokens, and audit logging; respects IFS FSM role-based permissions and contract entitlements
  • Webhooks: Optional asynchronous delivery for long-running workflows (e.g., appointment changes, debrief approvals)

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

  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 IFS FSM adapter tailored to your workflows and entitlements.

  1. Deploy with Monitoring

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

Schedule Integration Call →


Frequently Asked Questions

Q: Which IFS FSM modules can this integration cover?

Supergood supports workflows across commonly used modules such as Work Order Management, Scheduling & Dispatch, Installed Base/Assets, Contracts & Entitlements, and Field Debrief & Parts/Inventory, 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 debriefs and parts usage to our ERP?

Yes. We can normalize labor, parts, and expenses to match ERP schemas (e.g., cost centers, item codes, pricing) and deliver updates via webhooks or polling while complying with rate and permission constraints.

Q: Do you support assets, contracts, and warranty rules?

Yes. We can read installed-base assets, contract entitlements, SLA targets, and warranty coverage to validate work and enforce rules in automated flows.

Q: Are attachments and signatures supported?

Yes. We support downloading artifacts and uploading attachments and e-signatures via signed uploads, with checksum validation and time-limited URLs.



Ready to automate your IFS FSM workflows?

Supergood can have your IFS Field Service Management integration live in days with no ongoing engineering maintenance.

Get Started →

Read more