Subsidizers

Get a subsidizer

Fetches one subsidizer, active or not, with the person or company behind its creator filled in.

GET

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

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

subsidizerIdstringrequired

The subsidizer. A Snowflake id, sent as a decimal string.

example: 1830472847398404099

Response

200 · The subsidizer.

idstring

The subsidizer.

namestring

The subsidizer's name.

languagestring

ISO 639-1 language code used for messages to this subsidizer.

memostring

Internal note. Absent when none was written.

activeboolean

false once the subsidizer has been deactivated. Deactivated subsidizers are hidden from the default list but keep every subsidy already recorded against them.

websitestring

The subsidizer's website. Absent when none is on file.

contactobject

How to reach the subsidizer.

addressobject

The subsidizer's mailing address.

federalTaxInformationobject

Tax identification for the subsidizer. Absent when none is on file.

paymentSettingsobject

How the subsidizer pays.

typeenum<string>

What kind of body the subsidizer is.

governmentnonProfitprivateother

creatorobject

Who created the subsidizer record.

createdstring · date-time

When the subsidizer was created.

updatedstring · date-time

When the subsidizer was last changed.

creatorInfoobject

The person or company behind creator, filled in so you do not have to fetch them. Only the property that matches creator.type is present.

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

404 · No subsidizer with that id exists for the calling company. A record that belongs to another company is reported the same way as one that does not exist. The id you asked for is in `entityId`; `detail` names only the kind of record.

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.