MagicDoorAPI
SupportOpen MagicDoor
Vendors

List vendors

Returns a page of the company's vendors — the contractors, trades and management companies work is given to. Deleted vendors are never included; deactivated ones are unless you filter them out. Requires the vendors:read permission.

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

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

default: 50
namestring

Only vendors whose name matches.

categoryIdstring

Only vendors in this vendor category.

phoneNumberstring

Only vendors with this phone number.

emailstring

Only vendors with this email address.

isCompanyVendorboolean

true returns only the record that stands for the management company itself; false excludes it.

activeboolean

true returns only vendors that are still active; false returns only deactivated ones.

searchstring

Free-text search across the vendor.

portalStatusenum<string>

Only vendors at this stage of portal sign-up.

notInvitedinvitedactive

Response

200 · One page of vendors.

itemsobject[]required

The vendors on this page.

totalCountintegerrequired

How many vendors match in total.

totalPagesintegerrequired

How many pages there are at this page size.

pageintegerrequired

The page that was returned. Counting starts at 1.

pageSizeintegerrequired

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