Recurring work orders

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.

GET
https://services.magicdoor.com/maintenance/company-portal/work-orders/recurring

Authorization

Authorizationstringrequired
Bearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.

Query parameters

pageinteger

Which page to return. Counting starts at 1.

default: 1
pageSizeinteger

How many schedules to return per page. Between 1 and 100.

default: 50
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.

activeboolean

true returns only schedules still raising work; false only stopped ones.

searchstring

Free-text search across the schedule.

Response

200 · One page of recurring work orders.

itemsobject[]required

The schedules on this page.

totalCountintegerrequired

How many schedules match in total.

totalPagesintegerrequired

How many pages there are at this page size.

pageintegerrequired

The page that was returned. Counting starts at 1.

pageSizeintegerrequired

How many schedules were asked for per page.

401 · The request carried no valid access token.

403 · The token is not a property manager token, or it lacks the `work_orders:read` permission.