External insurance

List external insurance records

Returns every record of a policy a tenant bought from an insurer outside MagicDoor and submitted as proof, in any review state. This is not a Sure policy and not a damage waiver. The whole matching set comes back in one response, newest first.

GET
https://services.magicdoor.com/tenantinsurance/company-portal/insurance/externals

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

statesenum<string>[]

Return only records in these review states. Repeat the parameter once per value.

pendingapprovedrejected
leaseIdstring

Return only records for this lease.

propertyIdstring

Return only records for leases on this property.

portfolioIdstring

Return only records for leases in this portfolio.

includeDeletedboolean

Set to true to include deleted records as well as live ones.

default: false

Response

200 · Every matching record. This endpoint does not paginate.

itemsobject[]

The matching records, newest first.

totalCountinteger

How many records were returned. Because the whole set is returned at once, this always matches the length of items.

401 · The access token is missing, expired, or not a company portal token.