Portfolios

Get a portfolio overview

Returns the portfolio together with a rolled-up summary of everything under it — how its properties break down by type, how many units are occupied, and what the leases are worth.

GET

https://api.portal.magicdoor.com/company-app/portfolios/{portfolioId}/overview

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.

Path parameters

portfolioIdstringrequired

Snowflake id of the portfolio, as a decimal string.

example: 1830472847398404096

Response

200 · The portfolio and its rolled-up figures.

portfolioobject

The portfolio itself, without its properties expanded.

summaryobject

Roll-ups across every property in the portfolio. All of it is computed — none of these can be written.

cacheDatestring · date-time

When the summary was last recomputed, as a wall clock in the company's timezone with no offset.

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

404 · No portfolio with that id, or it belongs to another company.

The numbers may lag

The summary is computed from a cache. cacheDate tells you when it was last recomputed; anything that changed after that is not reflected yet.

Request

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

Response

{
  "portfolio": {
    "id": "1830472847398404096",
    "active": true,
    "name": "Riverside Holdings",
    "propertyCount": 12,
    "icons": [
      "star"
    ]
  },
  "summary": {
    "propertiesDistribution": {
      "multiFamily": 1,
      "townHome": 1
    },
    "activeProperties": 2,
    "totalProperties": 2,
    "occupiedUnits": 7,
    "activeUnits": 10,
    "unlistedUnits": 0,
    "totalUnits": 10,
    "vacantUnits": 3,
    "totalRent": 13400,
    "totalDeposit": 11200,
    "currentBalance": 1420.5
  },
  "cacheDate": "2026-08-17T20:00:00"
}