Subsidizers

List subsidizers

Returns a page of the company's subsidizers, newest first, with only the active ones shown unless you ask otherwise. The envelope also carries the people behind each subsidizer's creator.

GET

https://api.portal.magicdoor.com/company-app/subsidizers

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. Starts at 1. Note the asymmetry: the parameter is page, but the response reports it back as currentPage.

default: 1example: 1

pageSizeinteger

How many records per page. Between 1 and 100.

default: 50example: 50

typeenum<string>

Keep only subsidizers of this kind.

governmentnonProfitprivateother

activeboolean

true, the default, keeps only active subsidizers. false keeps only deactivated ones. There is no value that returns both.

default: true

searchstring

Keep subsidizers whose name or memo contains this text, ignoring case. 1 to 150 characters.

Response

200 · A page of subsidizers, plus the people behind their `creator` fields.

currentPageinteger

The page returned. Note the name: this envelope calls it currentPage, not page.

totalPagesinteger

How many pages the filter matches.

pageSizeinteger

How many records were asked for per page.

totalCountinteger

How many records the filter matches in total.

itemsSubsidizer[]

The records on this page.

propertyManagersobject[]

The property managers referenced by the creator of a subsidizer on this page.

tenantsobject[]

The tenants referenced by the creator of a subsidizer on this page.

vendorsobject[]

The vendors referenced by the creator of a subsidizer on this page.

ownersobject[]

The owners referenced by the creator of a subsidizer on this page.

401 · The access token is missing, expired, or does not belong to a property manager.

What a subsidizer is

A subsidizer is a body that pays part of a tenant's rent — a housing authority, a charity, an employer. It is a payer, not a person with a portal sign-in: there is no password, no invite and no portal status here. Subsidizers are attached to leases as lease subsidies, and the money they send appears on the lease ledger.

Deactivated subsidizers are hidden by default

active defaults to true, so a plain call returns only active subsidizers. Send active=false to see the deactivated ones. There is no way to get both in one page.