List work orders for the schedule board
Returns work orders for a calendar view, with their booked visits. Unlike the other lists it defaults to live work orders only — send active=false explicitly if you want the deactivated ones. There is no paging. Requires the work_orders:read permission.
Authorization
AuthorizationstringrequiredQuery parameters
portfolioIdsstring[]Only work orders in these portfolios. Repeat the parameter for more than one.
propertyIdsstring[]Only work orders on these properties.
unitIdsstring[]Only work orders on these units.
leaseIdsstring[]Only work orders tied to these leases.
vendorIdsstring[]Only work orders assigned to these vendors.
maintenanceRequestIdsstring[]Only work orders raised from these maintenance requests.
recurringWorkOrderIdsstring[]Only work orders raised by these recurring work orders.
statusenum<string>[]Only work orders in these states. Repeat the parameter for more than one.
referencestringOnly the work order with this reference number.
searchTextstringFree-text search across the work order.
activebooleantrue returns only live work orders; false only deactivated ones.
hasGroupChatbooleantrue returns only work orders that already have a group chat.
hasVendorbooleantrue returns only work orders with a vendor assigned; false only those still unassigned.
isScheduledbooleantrue returns only work orders with at least one visit booked; false only those with none.
closedAfterstring · date-timeOnly work orders closed on or after this moment.
scheduledTime.startstring · date-timeOnly work orders with a visit booked on or after this moment.
scheduledTime.endstring · date-timeOnly work orders with a visit booked on or before this moment.
Response
200 · The matching work orders, each carrying its `sessions`.
itemsobject[]requiredThe work orders. There is no count and no pagination envelope on this one.