Runbooks

List runbooks

Returns a page of runbooks — the written instructions MagicDoor follows when it handles a maintenance request on its own. The page mixes the company's own runbooks with the ones MagicDoor supplies to everybody; publicRunBook tells them apart. Requires the maintenance_runbooks:read permission.

GET
https://services.magicdoor.com/maintenance/company-portal/run-books

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 runbooks to return per page. Between 1 and 100.

default: 50
titlestring

Only runbooks whose title matches.

Response

200 · One page of runbooks. This is the short row shape — call [Get a runbook](api-reference/runbooks/get-runbook) for the script and the overrides.

itemsobject[]required

The runbooks on this page.

totalCountintegerrequired

How many runbooks match in total, across all pages.

totalPagesintegerrequired

How many pages there are at this page size.

pageintegerrequired

The page that was returned. Counting starts at 1.

pageSizeintegerrequired

How many runbooks 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 `maintenance_runbooks:read` permission.