MagicDoorAPI
SupportOpen MagicDoor
Custom views

List custom views

Returns the company's saved column layouts for one list screen, with MagicDoor's built-in default view appended last. Requires the settings:read permission.

GET
https://services.magicdoor.com/settings/company-portal/settings/custom-views/{type}

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.

Path parameters

typeenum<string>required

Which list screen the view belongs to. Matched case-insensitively, and echoed back in viewType exactly as spelled here.

example: LeasesUnitsPropertiesLeasesLeasesWithBalanceDueDraftLeasesExpiringLeasesPastLeasesLeasesWithMoveOutRequestsLeaseRentalApplicationsPropertyApplicationsAccountingBillsMaintenanceRequestsWorkOrdersWorkOrderBillsPropertyManagersOwnersTenants

Response

200 · The company's saved views, then the built-in default view.

idstringrequired

The view's Snowflake id, as a decimal string. The built-in default view returns the literal string default instead.

keystringrequired

The view's key, derived from its name and used to address it in the other endpoints.

namestringrequired

What the view is called on screen.

viewTypeenum<string>required

The list screen this view belongs to, capitalised.

UnitsPropertiesLeasesLeasesWithBalanceDueDraftLeasesExpiringLeasesPastLeasesLeasesWithMoveOutRequestsLeaseRentalApplicationsPropertyApplicationsAccountingBillsMaintenanceRequestsWorkOrdersWorkOrderBillsPropertyManagersOwnersTenants
favoritebooleanrequired

Whether this is the view the screen opens with. At most one view per type can be the favorite.

descriptionstring

Free text the property manager wrote about the view. Absent when none was given.

columnsobject[]required

The view's columns.

401 · The access token is missing, expired, or invalid.

403 · The caller does not hold the `settings:read` permission.

The built-in default view is not stored anywhere — it is assembled for each request, always comes last, and has id and key both set to default. It cannot be fetched, updated or deleted through the other endpoints in this section.

For screens that support company custom fields, the default view also lists each active, listable custom field as an unselected Custom column, so a UI can offer them without a second call. If that lookup fails the plain built-in view is returned instead.