MagicDoorAPI
SupportOpen MagicDoor
Settings

List stored settings

Returns every row the company has actually saved for one settings type — the company-level row and all overrides, flat and unresolved. Rows the company has never saved are simply absent; nothing is filled in with defaults. Requires the settings:read permission.

GET
https://services.magicdoor.com/settings/company-portal/settings/{settingsType}/all

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

settingsTypeenum<string>required

Which family of settings to act on. Matched case-insensitively against the registered settings types.

example: propertyachpaymentprocessingagentschatassociationviolationautopayincentiveschatchataichataileasechataileaserenewalchataileaserentersinsurancechataimaintenancerequestschataitranslationcommunicationscompanycontributiondepositpaymentdistributionemailemailnotificationlatefeesleasechartofaccountleaseinvoiceleaserenewalleaserentersinsurancemaintenancerequestmaintenancerequestrunbookmanagementfeeoutgoingpaymentspropertyrentalapplicationrentalapplicationbillingrentalapplicationchartofaccountrentalapplicationgeneralrentalapplicationpaymentrentalapplicationpaymentaccountrentalapplicationquestionnairerentalapplicationscreeningrentpaymentrentpaymentfailurefeerentpaymentnotificationrentpaymentprocessingfeessyndicationtenantautopayfailednotificationtenantpaymentremindertextworkorder

Response

200 · Every stored row, in no guaranteed order. Empty when nothing has been saved.

…settings propertiesobject

Each array element carries the properties of the chosen settings type at its top level, alongside the three fields below.

levelenum<string>

The kind of entity this stored row is attached to.

companyportfoliopropertyunitlease
levelIdstring

The id of the entity this stored row is attached to. At company level this is the company's own id.

groupIdstring

Identifies rows written together by a single multi-target override call. Absent on rows written on their own.

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

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

404 · No settings type is registered under the `settingsType` in the URL.