Brightly API
Brightly Software (a Siemens company) is a cloud CMMS and enterprise asset management platform spanning work orders, assets, inventory, capital planning, and energy management for education, government, healthcare, senior living, and manufacturing. Asset Essentials exposes a token-authenticated REST API, but coverage varies by module and edition. Supergood delivers a resilient, normalized API across your Brightly products so you can programmatically pull work orders, assets, parts, and purchase orders—and push new work orders, asset updates, and meter readings back into Brightly.
What is Brightly?
Brightly Software (a Siemens company) is a cloud-based computerized maintenance management (CMMS) and enterprise asset management (EAM) provider serving more than 11,000 clients across education, government, healthcare, senior living, manufacturing, and clubs. Organizations use Brightly to manage work orders and assets, plan capital investments, track inventory and parts, schedule facility events, and monitor energy and sustainability across their portfolios.
Core product families:
- Asset Essentials — enterprise work and asset management platform with a documented REST API
- TheWorxHub — cloud CMMS for facility and healthcare/senior-living maintenance operations
- Confirm and Assetic — enterprise infrastructure asset management for the public sector
- Origin and Predictor — strategic asset management, predictive modeling, and capital planning
- Energy Manager and Event Manager — utility/energy consumption tracking and facility scheduling
Common data entities:
- Work Orders, Tasks, Labor, and Status history
- Assets, Locations, and Asset Health/Lifecycle data
- Parts, Inventory, and Purchase Orders
- Meter Readings, Energy/Utility usage, and Events
- Users, Vendors, and Capital/Investment plans
The Brightly Integration Challenge
Maintenance and facilities teams run Brightly every day, but turning it into reliable API-driven automation across the product suite is non-trivial:
- Uneven API coverage: Asset Essentials publishes a REST API, but TheWorxHub, Confirm, Origin, Predictor, and Energy Manager have limited or no comparable public endpoints
- Token lifecycle management: Login tokens expire on a configurable window (Expires in minutes), so headless automation must refresh and replay sessions cleanly
- ID-versus-number ambiguity: Most objects carry both an ID and a NO field, and requests must use the back-end ID—an easy source of integration bugs
- Pagination and timezone handling: Responses are paginated with conservative page sizes, and date fields follow the API account's timezone, requiring careful UTC normalization
- Versioned and evolving endpoints: Some resources exist under v1 and v2 (work orders, meter readings), and Brightly notes rate limits may be imposed in the future
- Tenant-specific configuration: Custom fields, asset hierarchies, and work-order workflows differ per organization, so generic integrations break across deployments
How Supergood Creates Brightly APIs
Supergood combines Brightly's documented Asset Essentials REST API with reverse-engineered authenticated flows across the rest of the suite to deliver one resilient, normalized API layer for your Brightly tenant.
- Handles token login, configurable expiry, and MFA securely with automated refresh
- Manages pagination, ID-versus-NO resolution, and timezone-to-UTC normalization for you
- Normalizes responses across Work Orders, Assets, Parts, and Purchase Orders so you integrate once against consistent objects
- Aligns with tenant-specific custom fields, asset hierarchies, and workflow states to preserve compliant access
Use Brightly with AI agents: Brightly MCP Server →
Getting Started
- Schedule Integration Assessment
Book a 30-minute session to confirm your Brightly products, modules, and authentication model.
- Supergood Generates and Validates Your API
We deliver a production-ready Brightly adapter tailored to your tenant configuration and entitlements.
- Deploy with Monitoring
Go live with continuous monitoring and automatic adjustments as Brightly evolves.
API Endpoints
Authentication
/authenticateAuthenticate to a Brightly tenant via login credentials (and MFA where required) and obtain a session token for downstream calls.
Work Orders
/workordersList work orders with filters for status, location, assigned labor, priority, and date range across Asset Essentials.
Work Orders
/create_workorderCreate a new work order with tasks, assets, location, and assigned labor against your tenant's configured workflow.
Assets
/assetsRetrieve assets, locations, and asset health/lifecycle data with hierarchy and custom-field support.
Inventory
/partsPull parts and inventory records, including stock levels, vendors, and purchase order references.
Inventory
/purchase_ordersList purchase orders with line items, vendors, and receiving status for procurement reconciliation.
Use Cases
Sync work orders and assets into your data warehouse
- Pull work orders, tasks, and labor history from Asset Essentials into a central warehouse - Stream asset, location, and lifecycle data to downstream BI and reporting tools - Reconcile work-order status changes for unified maintenance reporting
Automate work-order creation and updates
- Push new work orders from monitoring, IoT, or ticketing systems into Brightly - Update status, labor, and completion details without portal clicks - Trigger preventive maintenance work orders from meter readings and thresholds
Reconcile parts, inventory, and procurement
- Sync parts, stock levels, and purchase orders into ERP and finance systems - Match part consumption against work orders for true maintenance cost - Surface low-stock and reorder events to procurement workflows
Power capital planning and asset health analytics
- Pull asset lifecycle and condition data for capital planning and forecasting - Feed meter readings and energy usage into sustainability dashboards - Combine work-order and asset data to prioritize replacement decisions
Technical Specifications
Authentication
Token-based login with configurable expiry and MFA, handled in a managed session
Connectivity
Brightly's documented Asset Essentials REST API plus authenticated browser flows for modules without public endpoints
Response format
Normalized JSON across Work Orders, Assets, Parts, and Purchase Orders objects
Rate limits
Adaptive throttling tuned to your tenant; Brightly currently enforces none but may add limits in the future
Session management
Automatic token refresh, expiry handling, and credential rotation
Data freshness
Near real-time pulls for work orders, assets, and parts with optional scheduled batch syncs
Security
Encrypted credential vault, scoped access tokens, SOC 2-aligned controls, and audit logging
Webhooks
Event-style callbacks for work-order status changes, asset updates, and inventory thresholds
Latency
Sub-second reads on cached entities; multi-second writes when posting through work-order workflows
Throughput
Horizontally scaled workers sized to multi-site work-order and asset volume
Reliability
Retry, backoff, and idempotency keys for work-order and inventory transactions
Adaptation
Continuous monitoring of Brightly releases, v1/v2 endpoint changes, and tenant configuration drift
Frequently asked questions
Yes. Asset Essentials has a documented REST API, and Supergood extends coverage to TheWorxHub, Confirm, Origin, Predictor, and Energy Manager through authenticated flows—so you integrate once across your Brightly suite.
Supergood manages Brightly's token login and configurable expiry window automatically, refreshing and replaying sessions so your integration never breaks on token timeout.
Brightly objects carry both a back-end ID and a user-facing NO. Supergood resolves and normalizes these so requests always use the correct identifier, eliminating a common source of integration errors.
Brightly currently enforces no rate limits on the Asset Essentials API but notes it may add them. Supergood applies adaptive throttling tuned to your tenant to stay within any future limits.
Yes. Supergood supports both reads and writes—creating and updating work orders, posting meter readings, and updating asset records—against your tenant's configured workflows and custom fields.