Reports

Inventory report

Lists what the company manages as a plain tree of portfolios, properties and units, with names and addresses and nothing else. One row is one unit. Meant for a picker or a printed index rather than for analysis.

GET

https://api.portal.magicdoor.com/company-app/reports/inventory

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

showInactiveboolean

Whether to include deactivated properties and units.

default: false

Response

200 · The portfolio, property and unit tree.

portfoliosobject[]

One entry per portfolio.

401 · The access token is missing, expired, or not valid for this company.

Properties whose portfolio is missing get a bucket of their own

A property whose portfolio could not be found is put into a synthetic portfolio named Unassigned. That one entry has no id at all, so check for the field rather than assuming every portfolio in the list is real.

Request

curl --request GET \
  --url 'https://api.portal.magicdoor.com/company-app/reports/inventory' \
  --header 'Authorization: Bearer <token>'

Response

{
  "portfolios": [
    {
      "id": "1830472847398401001",
      "name": "Downtown",
      "properties": [
        {
          "id": "1830472847398402002",
          "name": "Pine Street Duplex",
          "address": "412 W Pine St, Missoula, MT 59802",
          "units": [
            {
              "id": "1830472847398403003",
              "name": "A"
            }
          ]
        }
      ]
    }
  ]
}