Owner transfers

List owner contribution requests

Returns a page of the requests asking owners to put money into their properties, with each request's status and the contribution it produced once paid.

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

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. The first page is 1.

default: 1
pageSizeinteger

How many records to return per page. Between 1 and 100.

default: 50
propertyIdsstring[]

Return only requests for these properties. Repeat the parameter for each id.

statusesenum<string>[]

Return only requests in these states. Repeat the parameter for each status.

requestedpendingcompletedcancelled
requestDate.startstring · date-time

Return only requests raised at or after this moment, read in the company's timezone. Give at least one of requestDate.start and requestDate.end.

requestDate.endstring · date-time

Return only requests raised at or before this moment, read in the company's timezone.

dueDate.startstring · date-time

Return only requests due at or after this moment, read in the company's timezone. Give at least one of dueDate.start and dueDate.end.

dueDate.endstring · date-time

Return only requests due at or before this moment, read in the company's timezone.

amount.fromnumber

Lower bound of the requested amount. Give at least one of amount.from and amount.to.

amount.tonumber

Upper bound of the requested amount.

amount.includeFromboolean

Whether a request equal to amount.from is included.

default: true
amount.includeToboolean

Whether a request equal to amount.to is included.

default: true

Response

200 · A page of contribution requests.

itemsOwnerContributionRequest[]

The records on this page.

currentPageinteger

The page this response is.

totalPagesinteger

How many pages the filter produces.

pageSizeinteger

How many records a page holds.

totalCountinteger

How many records match the filter across all pages.

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