Settings

Get a company setting

Reads the value stored at company level for one settings type, or MagicDoor's built-in default when the company has never saved one. Overrides on portfolios, properties, units and leases are ignored — this is the base of the stack, not the effective value. Requires the settings:read permission.

GET

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

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-level value, or the built-in default.

…settings propertiesobject

The properties of the chosen settings type, spread across the top level of the response rather than nested. The example below is the property settings type.

levelenum<string>

The kind of entity this stored row is attached to. Present only when a company-level row is stored; absent when the response is the built-in default.

companyportfoliopropertyunitlease

levelIdstring

The id of the entity this stored row is attached to. At company level this is the company's own id. Present only when a company-level row is stored; absent when the response is the built-in default.

groupIdstring

Identifies rows written together by a single multi-target override call. Absent on rows written on their own. Present only when a company-level row is stored; absent when the response is the built-in default.

sourceenum<string>

Which level the returned value came from. Sent as the JSON value null when nothing is stored and the response is the built-in default. Note that this field is capitalised (Company, Property), unlike level elsewhere in the API.

CompanyPortfolioPropertyUnitLease

sourceIdstring

The id of the entity the returned value is stored against, matching source. Sent as the JSON value null when the response is the built-in default.

isDefaultbooleanrequired

true when no setting is stored anywhere the endpoint looked and the response is MagicDoor's built-in default for this settings type.

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.

MagicDoor settings are layered. A company saves one base value per settings type, then optionally overrides it for individual portfolios, properties, units or leases. This endpoint reads only the company-level row. To see what actually applies to one property or lease, use Resolve a setting.