Custom views

Get a custom view

Fetches one saved column layout by its key. The built-in default view has no stored record and cannot be fetched here. Requires the settings:read permission.

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

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
keystringrequired

The view's key — its name lowercased with every run of non-alphanumeric characters turned into a hyphen. A view's key changes when its name changes.

example: delinquent-leases

Response

200 · The 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.

404 · The company has no saved view with that key for that type.