Work Orders Overview

The Work Orders API provides endpoints for managing and interacting with maintenance work orders.

Key Concepts

Work Order Status

Work Orders can be in various states:

  • OPEN
  • COMPLETED
  • CANCELED
  • ON_HOLD
  • IN_PROGRESS

Work Order Priority

Work Orders can be categorized by different priorities:

  • LOW
  • MEDIUM
  • HIGH
  • URGENT

Work Order Entry Preference

Work Orders can have entry preference:

  • 24_HOUR_NOTICE
  • BY_APPOINTMENT
  • CALL_FIRST
  • NO_PREFERENCE
  • ANYTIME

Available Endpoints

EndpointSummaryMethod
/workordersList Work OrdersGET
/workordersCreate Work OrderPOST
/workorders/{workOrderId}Read Work OrderGET
/workorders/{workOrderId}Update Work OrderPUT
/workorders/{workOrderId}Delete Work OrderDELETE
/workorders/{workOrderId}/attachmentsList AttachmentsGET
/workorders/{workOrderId}/attachmentsCreate AttachmentPOST
/workorders/{workOrderId}/assignAssign Work OrderPATCH
/workorders/{workOrderId}/unassignUnassign Work OrderPATCH
/workorders/{workOrderId}/startStart Work OrderPATCH
/workorders/{workOrderId}/holdHold Work OrderPATCH
/workorders/{workOrderId}/completeComplete Work OrderPATCH
/workorders/{workOrderId}/cancelCancel Work OrderPATCH