List Settings Types

Retrieves all available settings types including their names, labels, and descriptions.

GET/api/{version}/configuration/settings

Headers

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

Request

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

Response

{
    "responseStatus": "SUCCESS",
    "types": [
        {
            "name": "email_settings__sys",
            "label": "Email Settings",
            "description": "Global email behavior and summary notification settings."
        },
        {
            "name": "versioning_settings__sys",
            "label": "Versioning Settings",
            "description": "Configurations for document versioning and draft creation."
        },
        {
            "name": "checkout_settings__sys",
            "label": "Checkout Settings",
            "description": "Controls for document checkout to local file systems or cloud storage."
        },
        {
            "name": "general_settings__sys",
            "label": "General Settings",
            "description": "Core Vault configurations including feature flags and binder options."
        },
        {
            "name": "security_settings__sys",
            "label": "Security Settings",
            "description": "Controls for user roles, sharing settings, and link security."
        }
    ]
}

Response Details

On SUCCESS, Vault returns a list of all available settings types with the following information:

Name	Description
`name`	The API name of the settings type.
`label`	The name displayed in the UI.
`description`	A summary of the settings type.