UpKeep API
UpKeep is a CMMS (Computerized Maintenance Management System) built for facilities, manufacturing plants, property portfolios, and maintenance teams to manage work orders, assets, preventive maintenance, inventory, and inspections. An unofficial API lets you programmatically pull work
What is UpKeep?
UpKeep is a cloud and mobile-first CMMS that centralizes maintenance operations across facilities, manufacturing, property, fleet, and utilities. Teams use UpKeep to capture maintenance requests, create and assign work orders, manage assets and locations, schedule preventive maintenance, control parts inventory, complete inspections/checklists, and report on labor, downtime, and cost.
Core product areas include:
- Work Order Management (Requests, Assignments, Statuses/SLAs, Priorities, Approvals)
- Asset Management (Asset Hierarchy, Locations, Tags/Serials, Meters, Documents)
- Preventive Maintenance (Time- and Meter-Based Schedules, Calendar, Auto-Generation)
- Inventory & Parts (SKUs, Bins, Unit Costs, Vendors, Reorder Points)
- Inspections & Checklists (Templates, Compliance Forms, Photo/Attachment Capture)
- Mobile Field Operations (Technician App, Barcode Scanning, Offline Mode)
- Reporting & Analytics (Downtime, MTTR, Labor/Parts Cost, Completion Rates)
Common data entities:
- Companies, Sites, Locations, Teams
- Users/Technicians (roles, permissions, certifications)
- Maintenance Requests (intake tickets, source, requester)
- Work Orders (status, priority, category, SLA, labor, parts, attachments)
- Assets/Equipment (tags, serials, parent-child hierarchy, meters, warranties)
- Preventive Maintenance Schedules (time/meter triggers, frequency, checklists)
- Parts/Inventory (SKUs, bins, quantities, unit cost, reorder thresholds)
- Meter Readings (counters, timestamps, units)
- Checklists/Inspections (templates, items, pass/fail, scores)
- Vendors/Suppliers (contacts, pricing)
- Documents/Attachments (photos, manuals, invoices)
- Time/Labor Entries (hours, rates, cost codes)
The UpKeep Integration Challenge
Maintenance teams rely on UpKeep every day, but turning portal-first workflows into API-driven automation is non-trivial:
- Role-aware portals: Requesters, technicians, and admins each see different data, permissions, and approvals
- Lifecycle rigor: Work orders traverse statuses, SLAs, sign-offs, and completion criteria that must be respected
- Asset context: Hierarchies, locations, meters, and attachments are spread across views and drives scheduling logic
- PM generation: Time/meter recurrences, grace periods, and backfills introduce edge cases for automation
- Mobile-first operations: Barcode scanning, offline completion, and photo capture create asynchronous updates
- Authentication complexity: MFA and session lifecycles complicate headless automation
- Export/API constraints: Teams report limited native exports, add-on API costs, rate limits, and gaps in webhooks for attachments or detailed cost data
How Supergood Creates UpKeep APIs
Supergood reverse-engineers authenticated browser flows and network interactions to deliver a resilient API endpoint layer for your UpKeep tenant.
- Handles username/password 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
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 UpKeep adapter tailored to your workflows and entitlements.
- Deploy with Monitoring
Go live with continuous monitoring and automatic adjustments as UpKeep evolves.
API Endpoints
Authentication
/sessionsEstablish a session using credentials. Supergood manages MFA (SMS, email, TOTP). 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.
Work Orders
/work-ordersCreate a work order with assignment, priority, and optional asset context.
Assets
/assetsCreate an asset with location, meter config, and warranty metadata.
Preventive Maintenance Schedules
/assets/{assetId}/pm-schedulesCreate a time- or meter-based PM schedule with checklist and auto-generation.
Inventory: Parts Consumption
/work-orders/{workOrderId}/parts-usageRecord parts used on a work order and adjust stock levels.
Use Cases
Work Order & Request Automation
- Mirror requests and work orders into your internal systems - Auto-create and assign work orders from your product, sensors, or customer portal - Update statuses, priorities, and SLA timestamps programmatically
Asset & Preventive Maintenance Sync
- Keep assets, meters, and warranties synchronized across EAM/ERP - Generate PM schedules and auto-create upcoming work orders - Post meter readings to trigger meter-based PMs
Inventory & Cost Tracking
- Track parts consumption against work orders and assets - Push labor hours and parts costs to accounting (e.g., QuickBooks, Xero) - Monitor stock levels, reorder points, and vendor pricing
Inspections & Field Reporting
- Ingest checklist templates and completion results - Attach photos/documents, unify QA/QC workflows, and drive follow-ups - Analyze pass/fail trends, downtime drivers, and compliance metrics
Technical Specifications
Authentication
Username/password with MFA (SMS, email, TOTP); 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, inventory, and inspection objects
Security
Encrypted transport, scoped tokens, and audit logging; respects UpKeep role-based permissions
Webhooks
Optional asynchronous delivery for long-running workflows (e.g., PM generation, work order status changes)
Latency
Sub-second responses for list/detail queries under normal load
Throughput
Designed for high-volume work order sync, PM generation, and parts consumption updates
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 & Requests, Assets, Preventive Maintenance, Inventory/Parts, Meter Readings, and Inspections/Checklists, subject to your licensing and entitlements. We scope coverage during integration assessment.
We support username/password + MFA (SMS, email, TOTP). Sessions are refreshed automatically with secure challenge handling.
Yes. We can normalize work order labor/parts and asset cost allocations to match your ERP/accounting schema (e.g., cost codes, taxes) and deliver updates via webhooks or polling while complying with rate and permission constraints. We commonly integrate with QuickBooks and Xero.
Yes. We support downloading attachments and uploading documents/photos via signed uploads, with checksum validation and time-limited URLs. Checklist templates and results are represented explicitly in our normalized responses.
Supergood operates as an unofficial integration that respects your entitlements and role-based access. We handle session automation for portal-first features and provide consistent endpoints even when native API/webhooks are limited. We discuss plan specifics and compliance during assessment.