List recurring work orders
Returns a page of recurring work orders — the schedules that raise a work order automatically every so often, for jobs like quarterly filter changes. These are the schedules, not the work orders they produce. Requires the work_orders:read permission.
Authorization
AuthorizationstringrequiredQuery parameters
pageintegerWhich page to return. Counting starts at 1.
pageSizeintegerHow many schedules to return per page. Between 1 and 100.
portfolioIdsstring[]Only schedules in these portfolios. Repeat the parameter for more than one.
propertyIdsstring[]Only schedules on these properties.
unitIdsstring[]Only schedules on these units.
vendorIdsstring[]Only schedules sending work to these vendors.
activebooleantrue returns only schedules still raising work; false only stopped ones.
searchstringFree-text search across the schedule.
Response
200 · One page of recurring work orders.
itemsobject[]requiredThe schedules on this page.
totalCountintegerrequiredHow many schedules match in total.
totalPagesintegerrequiredHow many pages there are at this page size.
pageintegerrequiredThe page that was returned. Counting starts at 1.
pageSizeintegerrequiredHow many schedules were asked for per page.