MaintainX

Supergood | MaintainX API

Alex Klarfeld

Alex Klarfeld

— 6 min read

Programmatically access MaintainX work orders, assets, preventive maintenance schedules, inspection forms, and parts inventory with a stable REST API. Supergood builds and operates production-grade, unofficial MaintainX integrations so your team can automate frontline operations without heavy custom engineering.

Plain English: MaintainX is maintenance and operations software (CMMS) for manufacturing plants, facilities teams, and field operations to manage work orders, assets, preventive maintenance, inspections, and parts inventory. An unofficial API lets you programmatically pull work orders, assets, PM schedules, checklists, meter readings, locations, users, and parts—and push new records or updates back into MaintainX.

For a tech company integrating with MaintainX, this means you can ingest real-time maintenance data to power dashboards, connect work orders to ERP/accounting (e.g., QuickBooks, Xero), automate PM generation from your product or IoT signals, sync inventory usage to procurement, and enrich your platform with procedures, inspections, and photos. You can trigger mobile notifications, log meter readings from sensors, attach documents, and keep stakeholder systems (MES, ERP, analytics, EHS, CRM) in lockstep.

What is MaintainX?

MaintainX (https://www.getmaintainx.com/) is a cloud CMMS platform that centralizes maintenance execution and frontline operations across plants, facilities, and distributed teams. Organizations use MaintainX to manage reactive and preventive work orders, track asset health and meter readings, standardize procedures and inspections, monitor parts and inventory, collaborate via mobile, and report on uptime, compliance, and costs.

Core product areas include:

  • Work Order Management (Reactive WOs, PMs, Priorities, Assignments, Comments, Photos)
  • Asset Management (Asset Catalog, Locations, Meters, Warranty, Downtime Tracking)
  • Preventive Maintenance (Schedules, Recurrence, Tasks, SLA/Compliance)
  • Procedures & Inspections (Checklists, Digital Forms, SOPs, Safety Audits)
  • Parts & Inventory (Parts Catalog, Stock Levels, Usage, Reorder Points)
  • Teams & Messaging (Users, Roles/Permissions, Mobile Notifications)
  • Reporting & Analytics (MTTR/MTBF, Completion Rates, Compliance, Cost Tracking)

Common data entities:

  • Organizations, Users, Roles/Permissions (Technicians, Supervisors, Requesters)
  • Work Orders (metadata, status/priority, due dates, assignees, labor, parts used, checklists)
  • Assets (metadata, serial/model, location, meters/readings, documents)
  • Locations (sites, buildings, lines, rooms)
  • Preventive Maintenance Schedules (frequency, tasks, next due dates)
  • Parts/Inventory (SKU, bin/location, quantity on hand, reorder point)
  • Work Requests (requester info, intake channel, triage state)
  • Procedures/Forms (inspection items, pass/fail, numeric readings)
  • Time Entries (users, hours, cost codes)
  • Attachments (photos, PDFs, manuals)

The MaintainX Integration Challenge

Maintenance teams rely on MaintainX daily, but turning mobile-first workflows into API-driven automation is non-trivial:

  • Role-aware access: Technicians, supervisors, and requesters each see different data, fields, and action rights
  • Mobile/offline behavior: Field updates, photos, and checklist completions sync asynchronously and must be reconciled
  • PM rigor: Recurrence, next-due logic, compliance, and SLA adherence require careful handling when generating/closing WOs
  • Data spread: Key context spans assets, work orders, procedures, parts usage, and meter readings across multiple views
  • Authentication complexity: SSO/MFA and rotating session lifecycles complicate headless automation
  • Export pain points: Teams often complain that CSV exports omit attachments/photos or custom fields, and native API access can be gated behind enterprise plans or carry extra costs

How Supergood Creates MaintainX APIs

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

Asset & Work Order Data Sync

  • Mirror assets, locations, and work orders into your internal systems or data warehouse
  • Keep asset metadata and meter readings current for reliability engineering
  • Normalize statuses, priorities, and assignees for multi-site operations

Preventive Maintenance Automation

  • Generate PM work orders based on runtime hours or IoT sensor thresholds
  • Push updated schedules, due dates, and procedures from your product
  • Track SLA/compliance and close the loop with signatures and inspection results

Inventory & Procurement Sync

  • Pull parts stock levels, reorder points, and usage to drive procurement
  • Log parts consumption from completed work orders and sync to ERP (e.g., QuickBooks, Xero)
  • Alert on stockouts and automate replenishment workflows

Field Reporting & Safety

  • Ingest inspection forms and pass/fail results for EHS dashboards
  • Attach photos and documents, unify QA/QC workflows, and trigger follow-ups
  • Aggregate downtime and completion data to power MTTR/MTBF analytics

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_mx_729c10",
    "name": "Maintenance Lead",
    "entitlements": ["work_orders", "assets", "pm_schedules", "parts_inventory"]
  }
}

Work Orders

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

Query parameters

  • status: open | in_progress | completed | canceled
  • priority: low | medium | high | critical
  • assetId: string
  • locationId: string
  • assignedUserId: string
  • dueFrom, dueTo: ISO 8601 dates
  • updatedFrom, updatedTo: ISO 8601 timestamps
  • page, pageSize: integers for pagination

Example response

{
  "items": [
    {
      "workOrderId": "wo_14c2e9",
      "title": "PM - Conveyor Belt A",
      "description": "Monthly lubrication and tension check.",
      "status": "open",
      "priority": "high",
      "assetId": "asset_8f3b11",
      "assetName": "Conveyor Belt A",
      "locationId": "loc_plant1_line2",
      "assignedTo": [
        {"userId": "u_27cbb4", "name": "Alex Ruiz"},
        {"userId": "u_18a9d0", "name": "Sam Patel"}
      ],
      "dueDate": "2026-02-10",
      "createdAt": "2026-01-21T09:02:10Z",
      "updatedAt": "2026-01-22T13:45:00Z",
      "checklist": [
        {"itemId": "chk_91c11", "label": "Inspect belt tension", "required": true, "completed": false},
        {"itemId": "chk_91c12", "label": "Lubricate bearings", "required": true, "completed": false}
      ],
      "partsRequired": [
        {"partId": "part_GREASE_G2", "name": "Lithium grease", "quantity": 1, "unit": "tube"}
      ],
      "attachments": [
        {"fileName": "pm_procedure.pdf", "url": "https://files.supergood.ai/temp/upl_09c311"}
      ]
    }
  ],
  "page": 1,
  "pageSize": 50,
  "total": 1
}

POST /work-orders: Create a work order with assignees, procedures, and parts.

curl --request POST \
  --url https://api.supergood.ai/integrations/<integration_id>/work-orders \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "title": "Reactive - Replace Pump Seal",
    "description": "Replace mechanical seal due to observed leak.",
    "assetId": "asset_pump_441",
    "locationId": "loc_plant1_room14",
    "priority": "critical",
    "status": "open",
    "dueDate": "2026-01-28",
    "assignedToUserIds": ["u_27cbb4"],
    "checklist": [
      {"label": "Isolate power", "required": true},
      {"label": "Remove pump cover", "required": true},
      {"label": "Replace mechanical seal", "required": true},
      {"label": "Leak test", "required": true}
    ],
    "partsRequired": [
      {"partId": "part_MECH_SEAL_2in", "quantity": 1},
      {"partId": "part_THREADLOCK_BLUE", "quantity": 1}
    ],
    "notifyAssignees": true,
    "attachments": [
      {"fileName": "pump_manual.pdf", "uploadToken": "upl_7fa223"}
    ],
    "referenceId": "mes-incident-9872"
  }'

Example response

{
  "workOrderId": "wo_5ab880",
  "status": "open",
  "priority": "critical",
  "assetId": "asset_pump_441",
  "createdAt": "2026-01-21T11:20:44Z"
}

Asset Meter Readings

PATCH /assets/{assetId}/meters: Update asset meter readings (e.g., runtime hours, cycles) to drive PM schedules.

curl --request PATCH \
  --url https://api.supergood.ai/integrations/<integration_id>/assets/asset_8f3b11/meters \
  --header 'Authorization: Bearer <authToken>' \
  --header 'Content-Type: application/json' \
  --data '{
    "readings": [
      {"meterType": "runtime_hours", "readingValue": 1248.7, "unit": "hours", "readingAt": "2026-01-22T08:12:00Z", "source": "sensor_gw_19"},
      {"meterType": "cycles", "readingValue": 91234, "unit": "count", "readingAt": "2026-01-22T08:12:00Z"}
    ]
  }'

Example response

{
  "assetId": "asset_8f3b11",
  "meters": [
    {"meterType": "runtime_hours", "lastReading": 1248.7, "unit": "hours", "updatedAt": "2026-01-22T08:12:05Z"},
    {"meterType": "cycles", "lastReading": 91234, "unit": "count", "updatedAt": "2026-01-22T08:12:05Z"}
  ],
  "nextPmDue": {
    "scheduleId": "pm_441_monthly",
    "dueDate": "2026-02-10",
    "trigger": "runtime_hours"
  }
}

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, assets, PM schedules, inspections, and inventory objects
  • Security: Encrypted transport, scoped tokens, and audit logging; respects MaintainX role-based permissions
  • Webhooks: Optional asynchronous delivery for long-running workflows (e.g., PM generation, WO status changes)

Performance Characteristics

  • Latency: Sub-second responses for list/detail queries under normal load
  • Throughput: Designed for high-volume work order sync and meter update processing
  • 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 MaintainX adapter tailored to your workflows and entitlements.

  1. Deploy with Monitoring

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

Schedule Integration Call →

Frequently Asked Questions

Q: Which MaintainX modules can this integration cover?

Supergood supports workflows across commonly used modules such as Work Order Management (Reactive, PM), Asset Management (Meters, Locations, Documents), Procedures & Inspections (Checklists, Forms), and Parts & Inventory (Stock Levels, Usage), 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 parts usage and costs to our ERP/accounting system?

Yes. We can normalize parts usage and work order cost data to match your ERP/accounting schema and deliver updates via webhooks or polling while complying with rate and permission constraints. We commonly integrate with QuickBooks and Xero.

Q: Are inspection forms and attachments (photos, PDFs) supported?

Yes. We support downloading inspection results and uploading attachments via signed uploads, with checksum validation and time-limited URLs. Attachment handling addresses common complaints where native exports omit images or large files.

Q: What if our PM schedules are driven by IoT sensors or meter thresholds?

We expose endpoints to post meter readings and can generate or update PMs based on thresholds, with debouncing and idempotency to prevent duplicate work orders.

Ready to automate your MaintainX workflows?

Supergood can have your MaintainX integration live in days with no ongoing engineering maintenance.

Get Started →

Read more