Retrieve Settings Type Values

Retrieves the metadata for a settings type, including any nested groups.

GET/api/{version}/configuration/settings/{type}

Headers

Name	Description
`Accept`	`application/json` (default) or `application/xml`

URI Path Parameters

Name	Description
`type`	The API name of the settings type. For example, `security_settings__sys`. Retrieve a list of all types available in your Vault with List Settings Types.

Request

curl -X GET -H "Authorization: {AUTH_VALUE}" \
-H "Accept: application/json" \
https://myvault.veevavault.com/api/v26.3/configuration/settings/email_settings__sys

Response

{
    "responseStatus": "SUCCESS",
    "data": {
        "name": "email_settings__sys",
        "groups": [
            {
                "name": "general",
                "settings": [
                    {
                        "name": "email_from_name",
                        "value": "Veeva Vault"
                    },
                    {
                        "name": "email_burst_threshold",
                        "value": null
                    },
                    {
                        "name": "enable_email_suppression_list",
                        "value": true
                    }
                ]
            },
            {
                "name": "email_summaries",
                "settings": [
                    {
                        "name": "max_notifications_per_type",
                        "value": 20
                    },
                    {
                        "name": "delivery_interval",
                        "value": 1
                    }
                ]
            }
        ]
    }
}

Response Details

On SUCCESS, Vault returns the metadata for the specified settings type. Individual settings are contained within settings groups. In the example above, email_settings__sys has two groups, general and email_summaries, with settings and their configured values nested within them.