MagicDoorAPI
SupportOpen MagicDoor
Settings

Get a setting with its overrides

Returns the company-level value for one settings type together with every override stored beneath it, so a settings screen can render the whole picture in one call. Nothing is resolved — each override is reported as stored, against the entity it belongs to. Requires the settings:read permission.

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

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 · The company base value and its overrides.

settingsobjectrequired

The company-level value, or the built-in default when no company-level row is stored. Its properties are those of the chosen settings type.

overridesobject[]required

Every stored row below company level, in no guaranteed order. Empty when the company has no overrides.

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.