GET Get Custom Preferences
GET /global_preferences/preference_groups/{group_id}/{instance_type}
Operation ID: Get Custom Preferences. Tags: global_preferences. Security: oauth2_application.
For the specified instance, read the custom preferences in the preference group at the global(organization) level. Specify 'current' to retrieve the preferences for the instance on which this call is being made. The system will recognize its type.
Note: If instance type sandbox is used, the preference values of development instance type will be returned as fallback.
This endpoint may return the following faults:
- 404 - CustomPreferenceGroupNotFoundException - Indicates the preference group is not found.
Parameters
instance_type(path, string, required) One of {staging,development,sandbox,production,current}.group_id(path, string, required) The ID of the preference group.mask_passwords(query, boolean) Set to true to mask the values of preferences of type Password.expand(query, array of string) The expansion "sites" retrieves the custom preferences in the preference group for all the available sites.
Responses
- 404
CustomPreferenceGroupNotFoundException- Indicates the preference group is not found.Media type:
application/json, text/xml. Schema:fault. - default
Media type:
application/json, text/xml. Schema:organization_preferences.