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.
Authorization
AuthorizationstringrequiredBearer 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
leaseIdstringReturn only records for this lease.
propertyIdstringReturn only records for leases on this property.
portfolioIdstringReturn only records for leases in this portfolio.
includeDeletedbooleanSet 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.
totalCountintegerHow many records were returned. Because the whole set is returned at once, this always matches the length of items.