Work orders represent maintenance tasks, repairs, and scheduled jobs across your facilities. Track them from creation through assignment, execution, and closure. Assign to staff or teams, set priorities and due dates, and monitor progress.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Facilio REST Work Orders API
version: 5.0.0
description: 'The Facilio REST API gives you programmatic access to Facilio''s Connected CMMS — the unified platform for managing property operations at portfolio scale. Build integrations that connect Facilio with your ERP, accounting systems, BMS, IoT platforms, and other business tools. Automate work order creation from external triggers, synchronize asset data across systems, push tenant and vendor records from your CRM, or pull maintenance data into your reporting dashboards. **What you can do with this API:**
- **Work Orders & Service Requests** — Create, assign, track, and close maintenance tasks programmatically
- **Assets** — Manage your equipment registry, track asset lifecycle, and sync with external asset management systems
- **Portfolio (Sites, Buildings, Floors, Spaces)** — Maintain your facility hierarchy and space data
- **People (Tenants, Vendors, Clients)** — Synchronize contacts and stakeholder records
- **Inventory (Item Types, Tool Types, Items & Tools, Services, Storerooms)** — Master data, per-storeroom item/tool balances (read), per-bin quantities by item or tool record, quantity adjustments, and warehouse locations
- **Procurement (Quotes, Purchase Requests, Purchase Orders, Receivable receiving, Invoices)** — Procurement with line items; receive against a PO via receivable APIs
- **Credit Notes (Vendor Credits, Client Credits)** — Manage credit notes for refunds and transaction adjustments with line items
- **Inventory Requests** — Track material requisitions from work orders to storerooms
- **Custom Modules** — Manage your organization''s custom modules — record types you define for the data and workflows that are specific to your business
- **Schema Discovery** — List all accessible modules and inspect field schemas (name, type, required, readOnly, lookup target) via `GET /modules` and `GET /{moduleName}/metadata`
- **Attachments & Comments** — Attach documents, photos, and notes to work orders and service requests
- **Picklists** — Discover available values for status, priority, category, and other configurable fields
The API follows REST conventions with JSON request/response bodies, standard HTTP methods (GET, POST, PATCH, DELETE), and consistent error handling across all endpoints. ## Base URL
```
https://{region}.facilioapis.com/{app_name}/api/v5
```
| Variable | Description | Values |
|----------|-------------|--------|
| `region` | Your deployment region | `us`, `au`, `ae`, `uk`, `us-azure`, `sa` |
| `app_name` | `maintenance` for API Key auth, `developer` for OAuth2 auth | `maintenance`, `developer` |
## Authentication
All API requests must be authenticated using one of the following methods:
### API Key (Personal Access Token)
Generate an API key from your Facilio account settings and pass it in the `x-api-key` header. The key inherits the permissions of the user who created it. ```
x-api-key: your-api-key-here
```
### OAuth2
For developer app integrations. Supports **authorization_code** and **password** grant types. | Endpoint | URL |
|----------|-----|
| Authorize | `https://{region}.facilioapis.com/identity/oauth2/authorize` |
| Token | `https://{region}.facilioapis.com/identity/oauth2/token` |
| Refresh | `https://{region}.facilioapis.com/identity/oauth2/token` (with `grant_type=refresh_token`) |
| Revoke | `https://{region}.facilioapis.com/identity/oauth2/revoke` |
Pass the access token as:
```
Authorization: Bearer oauth2
```
---
## List Operations
All list endpoints (`GET /{module}`) support these query parameters:
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `page` | integer | 1 | Page number (1-based) |
| `pageSize` | integer | 50 | Number of records per page. Maximum is 200. |
| `select` | string | — | Comma-separated field names to include in the response. If omitted, module default fields are returned. |
| `expand` | string | — | Comma-separated lookup field names to expand with full details (max 5).'
contact:
name: Facilio Support
url: https://facilio.com
license:
name: Proprietary
servers:
- url: https://{region}.facilioapis.com/{app_name}/api/v5
variables:
region:
description: Regional deployment
default: us
enum:
- us
- au
- ae
- uk
- us-azure
- sa
app_name:
description: '''maintenance'' for API Key, ''developer'' for OAuth2'
default: maintenance
enum:
- maintenance
- developer
security:
- apiKey: []
- oauth2: []
tags:
# --- truncated at 32 KB (37 KB total) ---
# Full source: https://artifacts.apis.io/facilio/openapi/facilio-work-orders-api-openapi.yml