MagicDoorAPI
SupportOpen MagicDoor
Portfolios

Get a portfolio

Fetches one portfolio with every property inside it, active and deactivated alike.

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

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.

idstring

Snowflake id of the portfolio.

activeboolean

false once the portfolio has been deactivated.

namestring

The portfolio's name, 1 to 150 characters.

propertyCountinteger

How many properties the portfolio holds, active and deactivated together. Maintained by MagicDoor; you cannot set it.

iconsstring[]

Icon keys pinned to the portfolio. Free-form strings; they are added and removed through the icons endpoints, not here.

activePropertyCountinteger

Computed: how many of properties are still active.

propertiesobject[]

Every property in the portfolio, active and deactivated alike, each with a count of its active units.

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

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