List work orders
Returns a page of the company's work orders — the scheduled jobs, as opposed to the maintenance requests that ask for them. Every filter below is optional and they combine. Requires the work_orders:read permission.
Authorization
AuthorizationstringrequiredQuery parameters
pageintegerWhich page to return. Counting starts at 1.
pageSizeintegerHow many work orders to return per page. Between 1 and 100.
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 · One page of work orders. This is the short row shape — call [Get a work order](api-reference/work-orders/get-work-order) for the description, the files and the bills.
itemsobject[]requiredThe work orders on this page.
totalCountintegerrequiredHow many work orders match in total.
totalPagesintegerrequiredHow many pages there are at this page size.
pageintegerrequiredThe page that was returned. Counting starts at 1.
pageSizeintegerrequiredHow many work orders were asked for per page.