MagicDoorAPI
SupportOpen MagicDoor
Vendors

Get a vendor's overview

Returns a dashboard for one vendor: the vendor record itself, their open work orders, what the company still owes them, six months of billing grouped by month, and how busy their chat is. Requires the vendors:read permission.

GET
https://services.magicdoor.com/maintenance/company-portal/vendors/{vendorId}/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

vendorIdstringrequired

The vendor to act on. A Snowflake id, sent as a decimal string.

example: 1826110384726355968

Response

200 · The overview.

vendorobjectrequired

The vendor record, in the same shape as Get a vendor.

unpaidBillsobjectrequired

Every bill from this vendor that still has money owing on it.

workOrdersobjectrequired

The vendor's work orders that are not closed.

transactionsobjectrequired

Billing over the last six months.

communicationsobjectrequired

The vendor's chat. Both counts are 0 when no chat has been opened.

cacheDatestring · date-timerequired

When the figures were taken, in the company's timezone and without an offset.

401 · The request carried no valid access token.

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

404 · No such vendor, or it belongs to another company.

`cacheDate` does not mean it is cached

Despite the name, this endpoint reads live every time. cacheDate is simply the moment the figures were gathered.