Rental applications

List rental applications

Returns a page of the company's rental applications with the pipeline stage, outstanding needs and screening rollup each one carries. Requires the rental_applications:read permission.

GET

https://services.magicdoor.com/leasing/company-portal/rental-applications

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.

default: 1example: 1

pageSizeinteger

How many applications to return. Between 1 and 100.

default: 50example: 50

stagesenum<string>[]

Restrict to these pipeline stages. Repeat the parameter for several, as in ?stages=submitted&stages=screened. Matching ignores case. An unknown value is rejected with 400.

draftsubmittedscreeneddecided

stageenum<string>

Single-value form of stages. When both are given the two sets are combined.

draftsubmittedscreeneddecided

decisionsenum<string>[]

Restrict to these decisions. Repeat the parameter for several.

noDecisionapprovedrejectedignored

needsenum<string>

Restrict to applications in one attention bucket. Matching ignores case; an unknown value is rejected with 400. Only one bucket at a time.

decisionOverduereadyToConvertreadyToApprovemissingDocsawaitingScreeningunpaidpausedForInfo

screeningVerifiedboolean

true returns only applicants whose identity TransUnion has verified, false only those it has not. Omit for both.

excludeRetractedboolean

Retracted applications are left out unless you set this to false.

default: true

sortenum<string>

Order of the results. -submittedAt puts the newest submissions first and is the default; lastName,firstName sorts alphabetically. Any other value is rejected with 400.

default: -submittedAt-submittedAtlastName,firstName

portfolioIdsstring[]

Restrict to applications interested in a unit in one of these portfolios. Repeat the parameter for several.

propertyIdsstring[]

Restrict to applications interested in a unit in one of these properties. Repeat the parameter for several.

unitIdsstring[]

Restrict to applications interested in one of these units. Repeat the parameter for several.

newOnlyboolean

Set to true to return only applications submitted within the last 14 days.

Response

200 · A page of rental applications.

itemsRentalApplicationSummary[]

The applications on this page.

totalCountinteger

How many applications match the filter across all pages.

totalPagesinteger

How many pages the result set has at this page size.

pageinteger

The page that was returned.

pageSizeinteger

How many applications were asked for per page.

400 · The `sort` value is not one of the two supported keys. An unknown `needs` value fails the same way with `errorCode` `bad_needs_filter`, and an unknown stage with `bad_request`.