Common
Get visible setting definitions and values
Returns setting definitions with their current effective values, filtered to those the caller's role/scope permits.
AuthorizationBearer <token>
JWT token to authenticate the request.
In: header
X-Api-Key<token>
API key, sent as a request header.
In: header
Query Parameters
scope?string
Case-insensitive match against the allowed values below. An unrecognized value returns INVALID_SCOPE_VALUE (400).
Value in
- "Global"
- "User"
- "Subscription"
- "Account"
application?string
Case-insensitive match against the allowed values below. An unrecognized value returns INVALID_APPLICATION_VALUE (400).
Value in
- "MDS"
- "MD"
- "MCLM"
- "MHCW"
- "MH"
subscriptionId?string
If present, must be a GUID belonging to the caller; substitutes that subscription's context for the caller's own subscription. Otherwise the caller's own subscription context is used.
Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/common/settings/get"{ "result": { "data": { "settings": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "key": "ALLOWED_SIGNATURE_INPUT_METHOD", "label": "Allowed Signature Input Method", "description": "Controls which signature input methods are permitted.", "value": "Draw,Type", "defaultValue": "Draw,Type,Upload", "type": "string", "icon": "signature", "allowedValues": "", "meta": { "application": "MH", "scope": { "name": "Account" }, "category": { "name": "Signing" }, "subCategory": { "name": "Input" }, "group": { "key": "signing", "name": "Signing" } } } ] }, "statusCode": 200, "message": "OK" }, "origin": "string", "dateTime": "string", "operationId": "string"}{ "error": { "innerErrors": [ { "code": "INVALID_SCOPE_VALUE", "message": "The provided scope value is not recognized.", "userMessage": "Invalid scope value provided." } ], "message": "The provided scope value is not recognized.", "statusCode": 400 }, "dateTime": "2026-01-01T12:00:00.0000000+00:00", "operationId": "common-settings-get", "origin": ""}{ "error": { "innerErrors": [ { "code": "VALIDATION_ERROR", "message": "Name is required.", "userMessage": "Name is required." } ], "message": "One or more validation errors occurred.", "statusCode": 400 }, "dateTime": "2026-01-01T12:00:00.0000000+00:00", "operationId": "00-abc123-00", "origin": "self-service-portal"}{ "error": { "innerErrors": [ { "code": "VALIDATION_ERROR", "message": "Name is required.", "userMessage": "Name is required." } ], "message": "One or more validation errors occurred.", "statusCode": 400 }, "dateTime": "2026-01-01T12:00:00.0000000+00:00", "operationId": "00-abc123-00", "origin": "self-service-portal"}{ "error": { "innerErrors": [ { "code": "FUNCTION_EXECUTION_ERROR", "message": "An unexpected error occurred while processing the request.", "userMessage": "Something went wrong. Please contact support." } ], "message": "An unexpected error occurred while processing the request.", "statusCode": 500 }, "dateTime": "2026-01-01T12:00:00.0000000+00:00", "operationId": "common-settings-get", "origin": ""}