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.
openapi: 3.0.3
info:
title: Facilio REST Assets 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.\n\nBuild 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.\n\n**What you can do with this API:**\n- **Work Orders & Service Requests** — Create, assign, track, and close maintenance tasks programmatically\n- **Assets** — Manage your equipment registry, track asset lifecycle, and sync with external asset management systems\n- **Portfolio (Sites, Buildings, Floors, Spaces)** — Maintain your facility hierarchy and space data\n- **People (Tenants, Vendors, Clients)** — Synchronize contacts and stakeholder records\n- **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\n- **Procurement (Quotes, Purchase Requests, Purchase Orders, Receivable receiving, Invoices)** — Procurement with line items; receive against a PO via receivable APIs\n- **Credit Notes (Vendor Credits, Client Credits)** — Manage credit notes for refunds and transaction adjustments with line items\n- **Inventory Requests** — Track material requisitions from work orders to storerooms\n- **Custom Modules** — Manage your organization's custom modules — record types you define for the data and workflows that are specific to your business\n- **Schema Discovery** — List all accessible modules and inspect field schemas (name, type, required, readOnly, lookup target) via `GET /modules` and `GET /{moduleName}/metadata`\n- **Attachments & Comments** — Attach documents, photos, and notes to work orders and service requests\n- **Picklists** — Discover available values for status, priority, category, and other configurable fields\n\nThe API follows REST conventions with JSON request/response bodies, standard HTTP methods (GET, POST, PATCH, DELETE), and consistent error handling across all endpoints.\n\n## Base URL\n\n```\nhttps://{region}.facilioapis.com/{app_name}/api/v5\n```\n\n| Variable | Description | Values |\n|----------|-------------|--------|\n| `region` | Your deployment region | `us`, `au`, `ae`, `uk`, `us-azure`, `sa` |\n| `app_name` | `maintenance` for API Key auth, `developer` for OAuth2 auth | `maintenance`, `developer` |\n\n## Authentication\n\nAll API requests must be authenticated using one of the following methods:\n\n### API Key (Personal Access Token)\nGenerate an API key from your Facilio account settings and pass it in the `x-api-key` header.\nThe key inherits the permissions of the user who created it.\n\n```\nx-api-key: your-api-key-here\n```\n\n### OAuth2\nFor developer app integrations. Supports **authorization_code** and **password** grant types.\n\n| Endpoint | URL |\n|----------|-----|\n| Authorize | `https://{region}.facilioapis.com/identity/oauth2/authorize` |\n| Token | `https://{region}.facilioapis.com/identity/oauth2/token` |\n| Refresh | `https://{region}.facilioapis.com/identity/oauth2/token` (with `grant_type=refresh_token`) |\n| Revoke | `https://{region}.facilioapis.com/identity/oauth2/revoke` |\n\nPass the access token as:\n```\nAuthorization: Bearer oauth2 <access_token>\n```\n\n---\n\n## List Operations\n\nAll list endpoints (`GET /{module}`) support these query parameters:\n\n| Parameter | Type | Default | Description |\n|-----------|------|---------|-------------|\n| `page` | integer | 1 | Page number (1-based) |\n| `pageSize` | integer | 50 | Number of records per page. Maximum is 200. |\n| `select` | string | — | Comma-separated field names to include in the response. If omitted, module default fields are returned. |\n| `expand` | string | — | Comma-separated lookup field names to expand with full details (max 5). By default, lookup fields return only `{id}`. |\n| `search` | string | — | Free-text search on the module's primary field (e.g. subject for work orders, name for assets). |\n| `sortBy` | string | — | Field name to sort by. Only sortable fields are accepted (see each module's documentation). |\n| `sortOrder` | string | `desc` | Sort direction: `asc` (ascending) or `desc` (descending). |\n| `count` | boolean | false | When `true`, the response includes a `count` field with the total number of matching records. |\n| `view` | string | — | Name of a saved view. Applies the view's columns, filters, and sort order. |\n| `changed` | string | — | UTC timestamp for delta sync (format: `yyyy-MM-dd'T'HH:mm:ss'Z'`). Returns records created or modified after this time. |\n\n---\n\n## Filtering\n\nApply filters by adding query parameters to any list endpoint. Filters are combined with AND logic.\n\n**Exact match:**\n```\nGET /workorder?status=Submitted&priority=High\n```\n\n**Operator match:**\n```\nGET /workorder?subject(contains)=HVAC&createdTime(after)=2026-01-01T00:00:00Z\n```\n\n### Operators by Field Type\n\n| Field Type | Example Fields | Operators | Value Format |\n|------------|----------------|-----------|--------------|\n| String | subject, name, description | `is`, `isn_t`, `contains`, `doesn_t_contain`, `starts_with`, `ends_with` | Text string |\n| Number | serialNumber, area, noOfTasks | `equals`, `not_equals`, `greater_than`, `less_than`, `greater_than_equal`, `less_than_equal`, `between` | Number (for `between`: two comma-separated values) |\n| Date/DateTime | createdTime, dueDate, scheduledStart | `is`, `isn_t`, `before`, `after`, `between`, `today`, `yesterday`, `current_week`, `last_week`, `current_month`, `last_month` | UTC `yyyy-MM-dd'T'HH:mm:ss'Z'` (value-less operators like `today` need no value) |\n| Boolean | highRisk, decommission | `equals`, `is` | `true` or `false` |\n| Lookup | resource, site, assignedTo, createdBy | `is`, `isn_t` | Record ID (integer) |\n| Picklist | status, priority, category, type | `is`, `isn_t` | Display name string (e.g. `Submitted`) or ID |\n| Enum | sourceType, urgency | `is`, `isn_t` | Display name string or index |\n| All types | Any field | `is_empty`, `is_not_empty` | No value needed |\n\n**Multiple values (OR within a field):**\n```\nGET /workorder?priority=High,Medium\n```\n\n---\n\n## Delta Sync\n\nFor incremental data synchronization, use the `changed` parameter to fetch only records that have been created or modified since your last sync:\n\n```\nGET /workorder?changed=2026-02-01T00:00:00Z\n```\n\nThis checks both the created time and modified time of each record (OR condition), so you get both new and updated records. You can combine `changed` with other filters.\n\n---\n\n## Custom Fields\n\nCustom fields are user-defined fields added via Facilio setup. They follow the naming pattern `{field_name}_{module}` (e.g. `po_reference_workorder`, `client_type_site`, `warranty_info_asset`).\n\n| Operation | Behavior |\n|-----------|----------|\n| **Single record GET** | Custom fields are automatically included in the response |\n| **List GET** | Custom fields are excluded by default. Use `?select=subject,po_reference_workorder` to include specific ones |\n| **Create / Update** | Pass custom fields in the request body alongside system fields |\n| **Filtering** | Custom fields can be used as filter parameters |\n| **Sorting** | Custom fields of primitive types (string, number, date) can be used with `sortBy` |\n\n> **Note:** Large text (BIG_STRING) custom fields are always excluded from list responses to prevent excessive memory usage. They are only available on single record GET.\n\n**Example — Create a work order with custom fields:**\n```json\n{\n \"data\": {\n \"subject\": \"HVAC Repair\",\n \"siteId\": 10,\n \"po_reference_workorder\": \"PO-2026-001\",\n \"cost_estimate_workorder\": 1500.00\n }\n}\n```\n\n---\n\n## Lookup fields in responses\n\nA **lookup** links your record to another record or to a controlled list (site, assignee, tenant, status, and so on). The JSON shape depends on which endpoint you call.\n\n### Lists (`GET /{module}`)\n\nBy default, each lookup is compact: `{ \"id\": <number> }`.\n\nTo load more detail on specific lookups, use `?expand=` with a comma-separated list of **lookup field names** (maximum **5** fields).\n\n### Single record, create, and update\n\nOn **GET** by id, **POST** create, and **PATCH** update, lookups that appear in the response are usually **expanded** into a small object instead of only an id.\n\nWhat you get is decided by **what the field points to**:\n\n- **Standard business records** in this API (for example site, tenant, asset, work order): the fields that module normally exposes, **including custom fields** you added on that target record. If the expanded object itself contains another lookup, that inner lookup stays compact: `{ \"id\" }` only.\n- **People and shared reference data** (for example `users`, `people`, `location`, `resource`): a **short, fixed list** of fields the API publishes — e.g. users typically include `id`, `name`, `email`, and `phone` when present. Internal database columns are not returned.\n- **Your org’s custom module** as the target: that module’s usual fields **plus** its custom fields.\n- **Any other target** not covered above: **`id`** and **`name`** only.\n\nSome fields behave as **picklists** (status, priority, category, type, …). They often return a **single text or id value** (e.g. `\"Submitted\"`) instead of a nested object. Check `GET /{moduleName}/metadata` for the field’s `dataType` and picklist details.\n\nProperties that are null are omitted from the JSON body.\n\n---\n\n## Response Format\n\n**Success — single record:**\n```json\n{\n \"success\": true,\n \"data\": { \"id\": 1, \"subject\": \"WO-1\", \"status\": \"Submitted\" }\n}\n```\n\n**Success — list:**\n```json\n{\n \"success\": true,\n \"data\": [ { \"id\": 1, ... }, { \"id\": 2, ... } ],\n \"pagination\": { \"page\": 1, \"pageSize\": 50 },\n \"count\": 120\n}\n```\n\n**Error:**\n```json\n{\n \"success\": false,\n \"error\": {\n \"code\": \"VALIDATION_ERROR\",\n \"message\": \"A specified field does not exist or is not accessible\"\n }\n}\n```\n\n---\n\n## Error Codes\n\n| Code | HTTP | Description |\n|------|------|-------------|\n| `UNAUTHORIZED` | 401 | Missing or invalid authentication |\n| `FORBIDDEN` | 403 | Insufficient permissions for this operation |\n| `MODULE_NOT_FOUND` | 404 | Module does not exist or is not accessible in this app |\n| `RECORD_NOT_FOUND` | 404 | Record with the given ID was not found |\n| `API_NOT_FOUND` | 404 | The API endpoint does not exist |\n| `VIEW_NOT_FOUND` | 404 | The specified saved view was not found |\n| `PICKLIST_NOT_FOUND` | 404 | The specified picklist field was not found |\n| `VALIDATION_ERROR` | 400 | Request body or parameters failed validation |\n| `INVALID_FIELD` | 400 | A specified field does not exist or is not accessible |\n| `INVALID_FILTER` | 400 | Filter syntax is invalid or operator not supported for field type |\n| `EXPAND_LIMIT_EXCEEDED` | 400 | More than 5 fields specified in `expand` parameter |\n| `METHOD_NOT_ALLOWED` | 405 | HTTP method not supported for this endpoint |\n| `CREATE_NOT_ALLOWED` | 403 | Create operation is disabled for this module |\n| `UPDATE_NOT_ALLOWED` | 403 | Update operation is disabled for this module |\n| `DELETE_NOT_ALLOWED` | 403 | Delete operation is disabled for this module |\n| `MODULE_NOT_ENABLED` | 403 | Module is not enabled for this organization |\n| `RATE_LIMITED` | 429 | Rate limit exceeded |\n| `INTERNAL_ERROR` | 500 | Unexpected server error |\n\n---\n\n## Rate Limiting\n\n- **Limit:** 100 requests per minute per API key / OAuth2 token\n- **Response:** HTTP 429 Too Many Requests when exceeded\n- **Recommendation:** Implement exponential backoff when receiving 429 responses\n\n---\n\n## HTTP Method Override\n\nSome systems only support POST and GET requests. To use PATCH, or DELETE through a POST request,\ninclude the `X-HTTP-Method-Override` header with the desired method.\n\n```\nPOST /workorder/13\nX-HTTP-Method-Override: PATCH\nContent-Type: application/json\n\n{ \"data\": { \"priority\": \"Low\" } }\n```\n\nThis is equivalent to `PATCH /workorder/13`. Supported override values: `PATCH`, `DELETE`.\nThe override header is only honored on POST requests.\n\n---\n\n## Field Types and Limits\n\n| Field Type | Max Length | Description |\n|------------|-----------|-------------|\n| String | 255 characters | Short text fields (e.g. subject, name, email) |\n| Large Text | 2,000 characters | Medium text fields (e.g. description) |\n| Big String | 32,000 characters | Long text fields (custom large text fields). Excluded from list API responses. |\n| Number | — | Integer or decimal values |\n| Date / DateTime | — | UTC format: `yyyy-MM-dd'T'HH:mm:ss'Z'` |\n| Boolean | — | `true` or `false` |\n| Lookup | — | Reference to another record. Pass the record ID on create/update. Returns `{id}` on list unless `?expand=` is used. On single-record GET (and typical create/update responses), expanded shape follows **Lookup fields in responses** above — not a single fixed `{id, name, email}` for every field. |\n| Picklist | — | Enumerated values (status, priority, category, type). Pass display name string (e.g. `\"High\"`) or numeric ID. |\n| Enum | — | System enum values. Pass display name string or index. |\n\nValues exceeding the maximum length will be rejected with a `VALIDATION_ERROR`.\n\n---\n\n## Additional Notes\n\n- **Skipping Workflows:** By default, workflow rules (automations, notifications, approvals) execute when you create or update a record. To skip them, pass the header `X-Execute-Workflows: false`. This is useful for bulk data imports or migrations where triggering automations is not desired.\n- **Picklist Fields:** Fields like status, priority, category, and type accept and return display name strings (e.g. `\"Submitted\"`, `\"High\"`, `\"Energy\"`). You can also pass the numeric ID.\n- **Lookup Fields:** On list API, lookup fields return `{id}` only unless `?expand=` is used. On single record GET (and create/update responses), lookups are expanded automatically; the property set depends on the lookup target module — see **Lookup fields in responses**.\n"
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:
- name: Work Orders
description: 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.
paths:
/workorder:
get:
tags:
- Work Orders
summary: List work orders
description: 'Returns a paginated list of work orders. Supports filtering, sorting, field selection, and saved views.
By default, returns module-configured fields. Use `?select=` to customize.
Custom fields can be included via `?select=subject,po_reference_workorder`.
'
operationId: listWorkOrders
parameters:
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/pageSize'
- $ref: '#/components/parameters/select'
- $ref: '#/components/parameters/expand'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/count'
- $ref: '#/components/parameters/view'
- $ref: '#/components/parameters/changed'
- name: sortBy
in: query
description: Field to sort by (only sortable fields accepted)
schema:
type: string
enum:
- id
- serialNumber
- subject
- actualWorkDuration
- actualWorkStart
- actualWorkEnd
- estimatedWorkDuration
- scheduledStart
- estimatedEnd
- responseDueDate
- dueDate
- noOfAttachments
- noOfClosedTasks
- noOfNotes
- noOfTasks
- createdTime
- modifiedTime
- name: sortOrder
in: query
schema:
type: string
enum:
- asc
- desc
default: desc
responses:
'200':
description: Paginated list of work orders
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ListResponse'
- type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/WorkOrder'
example:
success: true
data:
- id: 13
serialNumber: 13
subject: HVAC Repair - Building A
status: Submitted
priority: High
category: Energy
type: Corrective
sourceType: Web Work Order
siteId:
id: 10
resource:
id: 14
scheduledStart: '2026-02-12T16:27:24Z'
noOfAttachments: 0
createdTime: '2026-02-12T16:27:24Z'
createdBy:
id: 1
modifiedTime: '2026-02-12T16:27:24Z'
- id: 14
serialNumber: 14
subject: Plumbing leak in Floor 2
status: Work in Progress
priority: Medium
category: Plumbing
createdTime: '2026-02-13T09:15:00Z'
createdBy:
id: 2
pagination:
page: 1
pageSize: 50
'401':
$ref: '#/components/responses/Unauthorized'
post:
tags:
- Work Orders
summary: Create a work order
description: 'Creates a new work order. Requires `subject` and `site` at minimum.
Picklist fields (priority, category, type) accept display name strings (e.g. `"High"`) or numeric IDs.
Custom fields can be passed alongside system fields.
'
operationId: createWorkOrder
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
$ref: '#/components/schemas/WorkOrder'
example:
data:
subject: HVAC Repair - Building A
siteId: 10
priority: High
category: Energy
description: AC unit not cooling properly on Floor 3
assignedTo: 5
dueDate: '2026-02-15T17:00:00Z'
po_reference_workorder: PO-2026-001
responses:
'201':
description: Work order created successfully
content:
application/json:
example:
success: true
data:
id: 15
serialNumber: 15
subject: HVAC Repair - Building A
status: Submitted
priority: High
category: Energy
siteId:
id: 10
name: Headquarters
createdTime: '2026-02-14T10:00:00Z'
createdBy:
id: 1
name: Alex Johnson
email: alex.johnson@example.com
message: Record created
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
/workorder/{id}:
get:
tags:
- Work Orders
summary: Get a work order
description: 'Returns a single work order with all system fields, custom fields, and expanded lookup fields.
Lookup expansion follows **Lookup fields in responses** in the API overview.
'
operationId: getWorkOrder
parameters:
- $ref: '#/components/parameters/recordId'
- $ref: '#/components/parameters/select'
- $ref: '#/components/parameters/expand'
responses:
'200':
description: Work order details
content:
application/json:
example:
success: true
data:
id: 13
serialNumber: 13
subject: HVAC Repair - Building A
description: AC unit not cooling properly on Floor 3
status: Submitted
priority: High
category: Energy
type: Corrective
sourceType: Web Work Order
resource:
id: 14
name: AHU-01
siteId:
id: 10
name: Headquarters
assignedTo:
id: 5
name: John Smith
email: john@facilio.com
tenant:
id: 90
name: TechStart Inc
scheduledStart: '2026-02-12T16:27:24Z'
dueDate: '2026-02-15T17:00:00Z'
noOfAttachments: 2
noOfTasks: 3
createdTime: '2026-02-12T16:27:24Z'
createdBy:
id: 1
name: Alex Johnson
email: alex.johnson@example.com
modifiedTime: '2026-02-13T09:30:00Z'
po_reference_workorder: PO-2026-001
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- Work Orders
summary: Update a work order
description: 'Updates an existing work order. Only the fields included in the request body are updated;
omitted fields remain unchanged. Picklist fields accept display name strings or IDs.
'
operationId: updateWorkOrder
parameters:
- $ref: '#/components/parameters/recordId'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
$ref: '#/components/schemas/WorkOrder'
example:
data:
priority: Low
status: Work in Progress
assignedTo: 7
responses:
'200':
description: Work order updated successfully
content:
application/json:
example:
success: true
data:
id: 13
subject: HVAC Repair - Building A
status: Work in Progress
priority: Low
assignedTo:
id: 7
name: Jane Doe
email: jane@facilio.com
modifiedTime: '2026-02-14T11:00:00Z'
message: Record updated
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- Work Orders
summary: Delete a work order
description: Permanently deletes a work order. This action cannot be undone.
operationId: deleteWorkOrder
parameters:
- $ref: '#/components/parameters/recordId'
responses:
'200':
description: Work order deleted
content:
application/json:
example:
success: true
message: Record deleted
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
/workorder/{id}/tasks:
get:
tags:
- Work Orders
summary: List work order tasks
description: Returns checklist tasks for the work order, with each task including its photos.
operationId: listWorkOrderTasks
parameters:
- $ref: '#/components/parameters/recordId'
responses:
'200':
description: List of work order tasks
content:
application/json:
example:
success: true
data:
- id: 801
subject: Verify compressor pressure
description: Check suction and discharge pressure
status: open
photos:
- id: 1101
fileName: before.jpg
contentType: image/jpeg
type: before
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
post:
tags:
- Work Orders
summary: Create work order task
description: Creates a checklist task under the given work order.
operationId: createWorkOrderTask
parameters:
- $ref: '#/components/parameters/recordId'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
$ref: '#/components/schemas/WorkOrderTask'
example:
data:
subject: Inspect condenser coil
description: Capture before/after photos
responses:
'201':
description: Task created
content:
application/json:
example:
success: true
data:
id: 802
subject: Inspect condenser coil
status: open
photos: []
message: Task created
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
/workorder/{id}/tasks/{taskId}:
get:
tags:
- Work Orders
summary: Get work order task
description: Returns a single checklist task with photos.
operationId: getWorkOrderTask
parameters:
- $ref: '#/components/parameters/recordId'
- name: taskId
in: path
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Task details
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
data:
$ref: '#/components/schemas/WorkOrderTask'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
patch:
tags:
- Work Orders
summary: Update or complete work order task
description: Updates task fields. Set `status=closed` to complete the task and `status=open` to reopen.
operationId: updateWorkOrderTask
parameters:
- $ref: '#/components/parameters/recordId'
- name: taskId
in: path
required: true
schema:
type: integer
format: int64
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
$ref: '#/components/schemas/WorkOrderTask'
example:
data:
status: closed
responses:
'200':
description: Task updated
content:
application/json:
example:
success: true
message: Task updated
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
delete:
tags:
- Work Orders
summary: Delete work order task
operationId: deleteWorkOrderTask
parameters:
- $ref: '#/components/parameters/recordId'
- name: taskId
in: path
required: true
schema:
type: integer
format: int64
responses:
'200':
description: Task deleted
content:
application/json:
example:
success: true
message: Record deleted
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
/workorder/{id}/tasks/{taskId}/photos:
post:
tags:
- Work Orders
summary: Upload work order task photo
description: Uploads a task photo with type `before` or `after`. Only image files are accepted.
operationId: addWorkOrderTaskPhoto
parameters:
- $ref: '#/components/parameters/recordId'
- name: taskId
in: path
required: true
schema:
type: integer
format: int64
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
required:
- attachment
- type
properties:
attachment:
type: string
format: binary
description: Image file only (jpeg, png, gif, webp, bmp, tiff, heic/heif)
type:
type: string
enum:
- before
- after
responses:
'201':
description: Attachment uploaded
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
data:
type: array
items:
$ref: '#/components/schemas/WorkOrderTaskPhoto'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
/workorder/metadata:
get:
tags:
- Work Orders
summary: Get work order field schema
description: Returns the field schema for the workorder module, including all declared system fields and any org-specific custom fields with their data type, required/readOnly flags, and lookup targets.
operationId: getWorkOrderMetadata
parameters:
- $ref: '#/components/parameters/includeAllowedValues'
responses:
'200':
description: Field schema retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/ModuleMetaResponse'
'401':
$ref: '#/components/responses/Unauthorized'
'404':
$ref: '#/components/responses/NotFound'
components:
parameters:
pageSize:
name: pageSize
in: query
description: Records per page (max 200)
schema:
type: integer
default: 50
maximum: 200
page:
name: page
in: query
description: Page number (1-based)
schema:
type: integer
default: 1
changed:
name: changed
in: query
description: 'Delta sync: returns reco
# --- truncated at 32 KB (47 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/facilio/refs/heads/main/openapi/facilio-work-orders-api-openapi.yml