ServiceMax API
ServiceMax is field service management software used by asset-centric organizations to manage work orders, technician scheduling, installed base/asset records, service contracts and entitlements, parts inventory, and returns/repair. An unofficial API lets you programmatically pull wor
What is ServiceMax?
ServiceMax is a cloud platform for asset-centric field service management. Teams use ServiceMax to orchestrate work orders, schedule and dispatch technicians, track installed base/assets, manage contracts and entitlements, control parts and inventory, process RMAs and depot repair, and capture field data through mobile apps.
Core product areas include:
- Work Order & Task Management (e.g., service requests, task lists, status flows)
- Dispatch & Scheduling (e.g., territories, skills, calendars, appointments)
- Installed Base & Asset Management (e.g., serial numbers, locations, warranties, meters)
- Contracts & Entitlements (e.g., coverage rules, SLAs, pricing, warranties)
- Parts & Inventory (e.g., warehouses, bins, stock levels, consumption, RMAs)
- Maintenance Plans & PM Generation (e.g., job plans, cycles, triggers)
- Field Mobility (e.g., offline forms, photos, signatures, time/expense)
Common data entities:
- Accounts/Customers and Sites/Locations
- Work Orders, Service Tasks, and Appointments/Visits
- Technicians/Users, Skills, Territories, and Calendars
- Assets/Installed Products with serials, models, warranties, and meter readings
- Parts/Items, Warehouses/Bins, Shipments, and RMAs/Return Orders
- Service Contracts, Entitlements, SLAs, and Coverage Rules
- Time Entries, Expenses, Attachments, Notes, and Photos
The ServiceMax Integration Challenge
Field service teams rely on ServiceMax daily, but turning portal-based workflows into API-driven automation can be complex:
- Asset-centric models: Entitlements, warranties, and coverage rules must be enforced when creating or updating work orders
- Salesforce underpinnings: Profile/permission sets, record types, and sharing rules complicate headless automation and data access
- Scheduling constraints: Skill matching, territories, technician calendars, and travel estimates are optimized in the UI and must be respected programmatically
- Mobile/offline data: Technician submissions (photos, forms, time/expense) sync asynchronously and require careful reconciliation
- Enterprise security: SSO, MFA, and role-based controls introduce additional steps for automation and session continuity
How Supergood Creates ServiceMax APIs
Supergood reverse-engineers authenticated browser flows and network interactions to deliver a resilient API endpoint layer for your ServiceMax 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
- Maps picklist values and status transitions into stable enums you can integrate against
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 ServiceMax adapter tailored to your workflows and entitlements.
- Deploy with Monitoring
Go live with continuous monitoring and automatic adjustments as ServiceMax 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.
Work Orders
/work-ordersList work orders with filters and summary details.
Appointments (Dispatch)
/work-orders/{workOrderId}/appointmentsCreate a technician appointment with scheduling metadata.
Parts Usage
/work-orders/{workOrderId}/parts-usageRecord parts consumed on a work order with costing and inventory context.
Asset Meter Readings
/assets/{assetId}/meter-readingsAdd a new meter reading for an asset to support PM triggers and diagnostics.
Use Cases
Work Order and Asset Sync
- Mirror work orders, appointments, assets, and customers into your internal systems - Keep asset metadata current (serials, locations, warranty dates, meters) for analytics and service planning - Normalize statuses and priorities to power SLA dashboards and escalations
Dispatch and Scheduling Automation
- Trigger appointments based on IoT alerts or external events - Auto-assign technicians by skills, territory, and availability - Orchestrate status changes and notifications as work progresses
Contracts and Entitlements
- Verify coverage and SLAs before creating or scheduling work orders - Push contract updates and renewal dates from your CRM/ERP - Track actual response/repair times against entitlements for compliance
Parts and Inventory Reconciliation
- Record parts consumption from the field and reconcile stock levels - Sync usage and costs to ERP (e.g., NetSuite, SAP, QuickBooks) - Automate RMAs and depot repair handoffs with attachments and shipment details
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, appointments, assets, contracts/entitlements, and inventory objects
Security
Encrypted transport, scoped tokens, and audit logging; respects ServiceMax role-based permissions and coverage rules
Webhooks
Optional asynchronous delivery for long-running workflows (e.g., entitlement checks, appointment updates, RMA processing)
Latency
Sub-second responses for list/detail queries under normal load
Throughput
Designed for high-volume work order sync and parts usage recording
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 Work Orders & Tasks, Dispatch & Scheduling, Installed Base/Assets, Contracts & Entitlements, Parts & Inventory, and RMAs/Depot Repair, 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 parts, warehouses/bins, and usage to match your ERP schema (e.g., NetSuite, SAP, 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.