MagicDoorAPI
SupportOpen MagicDoor
Resident benefit packages

List resident benefit enrollments

Returns a page of the company’s enrollments, newest first, filterable by status, package, lease, tenant or property. Requires the resident_benefit_packages:read permission.

GET
https://services.magicdoor.com/productexperiences/company-portal/resident-benefit-packages/enrollments

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: 1
pageSizeinteger

How many enrollments per page. Between 1 and 100.

default: 50
statusenum<string>

Return only enrollments in this status.

pendingActivationactivecancelled
packageIdstring

Return only enrollments in this package, as a Snowflake id in decimal string form.

leaseIdstring

Return only enrollments on this lease, as a Snowflake id in decimal string form.

tenantIdstring

Return only this tenant's enrollments, as a Snowflake id in decimal string form.

propertyIdstring

Return only enrollments at this property, as a Snowflake id in decimal string form.

Response

200 · A page of enrollments, newest first.

itemsobject[]required

The enrollments on this page.

totalCountintegerrequired

How many enrollments match the filter in total.

totalPagesintegerrequired

How many pages that comes to at the current page size.

pageintegerrequired

The page this response is.

pageSizeintegerrequired

How many enrollments were asked for per page.

400 · `page` is below 1, `pageSize` is outside 1 to 100, or an id filter is not a valid Snowflake id.

401 · The request carried no valid access token.

403 · The caller is not a property manager, or is missing the `resident_benefit_packages:read` permission.