Subsidizers

Get several subsidizers

Fetches up to 100 subsidizers by id in one call. Use it to fill in the subsidizers behind a list of ids you already hold.

GET

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

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

subsidizerIdsstring[]required

The subsidizers to fetch. Repeat the parameter, or send one comma-separated list. At least 1 and at most 100 ids, each a positive Snowflake id as a decimal string.

example: 1830472847398404099

Response

200 · The subsidizers.

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.

400 · No ids were sent, more than 100 were sent, or one of them is not a positive whole number.

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.

Every id must resolve

If any id in the list does not exist, or belongs to another company, the whole call fails with 404.