Owners

Get several owners

Fetches up to 100 owners by id in one call, each with their property stakes and payment accounts.

GET

https://api.portal.magicdoor.com/company-app/owners/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

ownerIdsstring[]required

The owners 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: 1830472847398404097

Response

200 · The owners.

idstring

The owner.

activeboolean

false once the owner has been deactivated. A deactivated owner cannot sign in and cannot be given a new password.

emailstring

Email address. Absent when none is on file.

firstNamestring

Given name, or the company name when isCompany is true.

lastNamestring

Family name. Absent for a company, or when only a first name is on file.

isCompanyboolean

true when the owner is a business rather than a person.

phonestring

Phone number, formatted for reading. Absent when none is on file.

federalTaxInformationobject

Tax identification used for the owner's 1099. Absent when none is on file.

createdstring · date-time

When the owner record was created.

updatedstring · date-time

When the owner record was last changed.

lastSeenstring · date-time

When the owner last used the owner portal. Absent when they never have.

lastPortalInvitestring · date-time

When a portal invite was last sent. Absent when none ever was.

chatIdstring

The owner's conversation with the company. Absent when no conversation exists.

languagestring

ISO 639-1 language code used for messages to this owner. Defaults to en.

iconsstring[]

Icon keys a property manager has pinned to the owner. Always present, possibly empty.

addressobject

The owner's mailing address.

portalStatusenum<string>

Where the owner is in getting onto the owner portal: notInvited, invited (invited but never signed in), active (has signed in).

notInvitedinvitedactive

ownerPropertiesobject[]

This owner's stake in each property they own, as a link record.

portfoliosobject[]

The portfolios holding those properties.

propertiesobject[]

The properties themselves.

paymentAccountsobject[]

The accounts MagicDoor can pay this owner through. Account and card numbers are reduced to their last four digits.

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 owner 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.