GET Get Custom Site Preferences
GET /sites/{site_id}/site_preferences/preference_groups/{group_id}/{instance_type}
Operation ID: Get Custom Site Preferences. Tags: sites. Security: oauth2_application.
For the specified site and instance, read the custom preferences in the preference group. Specify 'current' to retrieve the preferences for the instance on which this call is being made. The system will recognize its type.
This endpoint may return the following faults:
- 404 - CustomPreferenceGroupNotFoundException - Indicates the preference group is not found.
Parameters
site_id(path, string, required) The site context.
Minimum length: 1.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.
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:site_preferences.