> ## Documentation Index
> Fetch the complete documentation index at: https://developer.vanta.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get risk settings

> Get this domain's risk settings: the stages risks are scored at, the
categories risk scenarios can belong to, and the custom fields configured
for risk scenarios.

Use `GET /risk-registers` to see which custom fields apply to each
register.



## OpenAPI

````yaml /reference/manage-vanta.json get /risk-settings
openapi: 3.0.0
info:
  title: Manage Vanta
  version: 1.0.0
  description: >-
    The REST API lets customers query and mutate Vanta's data. Use this API to
    automate bulk actions, query data for custom workflows and dashboards, and
    bolster your security operations


    **Note for Vanta Gov (FedRAMP) customers:** Select `Vanta Gov (FedRAMP)`
    from the server dropdown to issue requests against
    `https://api.vanta-gov.com`. The OAuth token URL shown below defaults to the
    commercial host — replace it with `https://api.vanta-gov.com/oauth/token`.
  termsOfService: https://www.vanta.com/terms
  license:
    name: UNLICENSED
  contact:
    name: API Support
    url: https://help.vanta.com/
    email: support@vanta.com
servers:
  - url: https://api.vanta.com/v1
    description: Vanta (Commercial)
  - url: https://api.vanta-gov.com/v1
    description: Vanta Gov (FedRAMP)
security: []
paths:
  /risk-settings:
    get:
      tags:
        - Risk Settings
      summary: Get risk settings
      description: >-
        Get this domain's risk settings: the stages risks are scored at, the

        categories risk scenarios can belong to, and the custom fields
        configured

        for risk scenarios.


        Use `GET /risk-registers` to see which custom fields apply to each

        register.
      operationId: GetRiskSettings
      parameters: []
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RiskSettings'
              examples:
                Example 1:
                  value:
                    scoreProfile:
                      profileType: CLASSIC
                      scoreStages:
                        - stageKey: CURRENT
                          label: Residual risk
                          description: null
                        - stageKey: TARGET
                          label: Target risk
                          description: null
                    categories:
                      - name: Access control
                        type: VANTA_DEFAULT
                      - name: Supply chain
                        type: CUSTOM
                    customFields:
                      - label: Business unit
                        description: null
                        dataType: PICKLIST
                        picklistOptions:
                          - Engineering
                          - Finance
                        decimalPlaces: null
                        currency: null
      security:
        - bearerAuth: []
components:
  schemas:
    RiskSettings:
      description: |-
        The domain's risk settings: the stages risks are scored at, and the
        categories and custom fields available on risk scenarios.
      properties:
        scoreProfile:
          allOf:
            - $ref: '#/components/schemas/RiskScoreProfile'
          nullable: true
          description: >-
            The stages every risk is scored at, with the domain's names for
            them.

            `null` when score stages aren't available to the domain.
        categories:
          items:
            $ref: '#/components/schemas/RiskCategory'
          type: array
          description: >-
            The categories risk scenarios can belong to: Vanta's default
            categories

            followed by the domain's custom ones. A category's `name` is the
            value

            accepted in the `categories` field on risk-scenario create and
            update

            requests.
        customFields:
          items:
            $ref: '#/components/schemas/RiskCustomField'
          type: array
          description: The custom fields configured for risk scenarios, in display order.
      required:
        - scoreProfile
        - categories
        - customFields
      type: object
      additionalProperties: false
    RiskScoreProfile:
      properties:
        profileType:
          $ref: '#/components/schemas/RiskScoreProfileType'
          description: |-
            `CLASSIC` scores the `CURRENT` and `TARGET` stages. `ADVANCED` also
            scores `INHERENT`.
        scoreStages:
          items:
            $ref: '#/components/schemas/RiskScoreStage'
          type: array
          description: The stages, in display order.
      required:
        - profileType
        - scoreStages
      type: object
      additionalProperties: false
    RiskCategory:
      properties:
        name:
          type: string
        type:
          $ref: '#/components/schemas/RiskCategoryType'
          description: >-
            `VANTA_DEFAULT` for a category Vanta provides, or `CUSTOM` for one
            the

            domain created.
      required:
        - name
        - type
      type: object
      additionalProperties: false
    RiskCustomField:
      properties:
        label:
          type: string
          description: |-
            The value accepted as `label` in the `customFields` field on
            risk-scenario create and update requests.
        description:
          type: string
          nullable: true
        dataType:
          $ref: '#/components/schemas/RiskCustomFieldDataType'
        picklistOptions:
          items:
            type: string
          type: array
          nullable: true
          description: The values a `PICKLIST` field accepts. `null` for other data types.
        decimalPlaces:
          type: number
          format: double
          nullable: true
          description: >-
            The number of decimal places a `DECIMAL` field keeps. `null` for
            other

            data types.
        currency:
          allOf:
            - $ref: '#/components/schemas/RiskCustomFieldCurrency'
          nullable: true
          description: The currency of a `CURRENCY` field. `null` for other data types.
      required:
        - label
        - description
        - dataType
        - picklistOptions
        - decimalPlaces
        - currency
      type: object
      additionalProperties: false
    RiskScoreProfileType:
      type: string
      enum:
        - CLASSIC
        - ADVANCED
    RiskScoreStage:
      properties:
        stageKey:
          $ref: '#/components/schemas/RiskScoreStageKey'
          description: >-
            What the stage measures. `INHERENT` is risk before any controls,

            `CURRENT` is risk with today's controls, and `TARGET` is risk
            expected

            after planned treatment.
        label:
          type: string
          description: The domain's name for this stage.
        description:
          type: string
          nullable: true
      required:
        - stageKey
        - label
        - description
      type: object
      additionalProperties: false
    RiskCategoryType:
      type: string
      enum:
        - VANTA_DEFAULT
        - CUSTOM
    RiskCustomFieldDataType:
      type: string
      enum:
        - CURRENCY
        - DATE
        - DECIMAL
        - INTEGER
        - PICKLIST
        - STRING
        - USER
    RiskCustomFieldCurrency:
      properties:
        code:
          type: string
          description: ISO 4217 currency code, such as `USD`.
        unit:
          $ref: '#/components/schemas/RiskCustomFieldCurrencyUnit'
          description: |-
            The unit amounts are shown in: `K` (thousands), `M` (millions),
            `B` (billions), or `DEFAULT` (no unit).
      required:
        - code
        - unit
      type: object
      additionalProperties: false
    RiskScoreStageKey:
      type: string
      enum:
        - INHERENT
        - CURRENT
        - TARGET
    RiskCustomFieldCurrencyUnit:
      type: string
      enum:
        - DEFAULT
        - K
        - M
        - B
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

## Related topics

- [Get risk register by ID](https://developer.vanta.com/api-reference/risk-registers/get-risk-register-by-id.md)
- [Get vendor alert settings](https://developer.vanta.com/api-reference/vendor-alert-settings/get-vendor-alert-settings.md)
- [Get risk scenario by ID](https://developer.vanta.com/api-reference/risk-scenarios/get-risk-scenario-by-id.md)
- [Get personnel notification settings](https://developer.vanta.com/api-reference/personnel-notification-settings/get-personnel-notification-settings.md)
- [Get organization notification settings for an audit](https://developer.vanta.com/api-reference/audits/get-organization-notification-settings-for-an-audit.md)
