Owners

List owners

Returns a page of the company's owners ordered by first name then last name, each with the properties they hold a stake in. The envelope also carries those portfolios, properties and custom field definitions.

GET

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

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

activeboolean

true keeps only active owners, false only deactivated ones. Omit to get both.

firstNamestring

Keep owners whose given name matches this text.

lastNamestring

Keep owners whose family name matches this text.

firstOrLastNamestring

Keep owners whose given name or family name matches this text.

phonestring

Keep owners with this phone number.

emailstring · email

Keep owners with this email address.

portalStatusenum<string>

Keep owners at this stage of portal sign-up.

notInvitedinvitedactive

created.startstring · date-time

Keep owners created on or after this moment.

created.endstring · date-time

Keep owners created on or before this moment. At least one end of the range must be given if you use it at all.

ownerIdsstring[]

Keep only these owners. Repeat the parameter for several ids.

portfolioIdsstring[]

Keep owners with a stake in a property in one of these portfolios. Repeat the parameter for several ids.

propertyIdsstring[]

Keep owners with a stake in one of these properties. Repeat the parameter for several ids.

searchstring

Free-text search across the owner's indexed details.

Response

200 · A page of owners, plus the records they refer to.

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.

itemsOwner[]

The records on this page.

portfoliosobject[]

Every portfolio referenced on this page, listed once each.

propertiesobject[]

Every property referenced on this page, listed once each.

customFieldsobject[]

The custom field definitions behind the customFieldValues on this page.

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

Owner records can hold a taxpayer id

federalTaxInformation.taxId is a Social Security or Employer Identification Number and is returned in full. Treat the response as personal data.