> ## 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.

# List risk registers

> List the risk registers in this domain.

The `name` field of each register is the value to use in the
`riskRegister` field on `POST /risk-scenarios` and
`PATCH /risk-scenarios/{id}`. In domains with multiple registers,
`riskRegister` is required on risk-scenario create. Registers with
`registerType: "ENTERPRISE"` are system-managed. Each register's
`settings.applicableCustomFields` lists the custom field labels that can be
set on its risk scenarios.



## OpenAPI

````yaml /reference/manage-vanta.json get /risk-registers
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-registers:
    get:
      tags:
        - Risk Registers
      summary: List risk registers
      description: >-
        List the risk registers in this domain.


        The `name` field of each register is the value to use in the

        `riskRegister` field on `POST /risk-scenarios` and

        `PATCH /risk-scenarios/{id}`. In domains with multiple registers,

        `riskRegister` is required on risk-scenario create. Registers with

        `registerType: "ENTERPRISE"` are system-managed. Each register's

        `settings.applicableCustomFields` lists the custom field labels that can
        be

        set on its risk scenarios.
      operationId: ListRiskRegisters
      parameters:
        - in: query
          name: pageSize
          required: false
          schema:
            $ref: '#/components/schemas/PageSize'
        - in: query
          name: pageCursor
          required: false
          schema:
            $ref: '#/components/schemas/PageCursor'
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedResponse_RiskRegister_'
              examples:
                Example 1:
                  value:
                    results:
                      data:
                        - id: 5f2c939a52855e725c8d5824
                          name: Default
                          description: null
                          registerType: SCOPED
                          creationDate: '2024-03-07T18:46:05.944Z'
                          settings:
                            applicableCustomFields:
                              - Business unit
                      pageInfo:
                        hasNextPage: false
                        hasPreviousPage: false
                        startCursor: 5f2c939a52855e725c8d5824
                        endCursor: 5f2c939a52855e725c8d5824
      security:
        - bearerAuth: []
components:
  schemas:
    PageSize:
      type: integer
      format: int32
      default: 10
      description: >-
        Controls the maximum number of items returned in one response from the
        API.
      minimum: 1
      maximum: 100
    PageCursor:
      type: string
      description: >-
        A marker or pointer, telling the API where to start fetching items for
        the subsequent page in a paginated dataset.

        Note that the requested page will not include the item that corresponds
        to this cursor but will start from the one immediately

        after this cursor.
    PaginatedResponse_RiskRegister_:
      properties:
        results:
          properties:
            data:
              items:
                $ref: '#/components/schemas/RiskRegister'
              type: array
            pageInfo:
              $ref: '#/components/schemas/PageInfo'
          required:
            - data
            - pageInfo
          type: object
      required:
        - results
      type: object
      additionalProperties: false
    RiskRegister:
      description: |-
        A risk register — a grouping of risk scenarios.

        Risk scenarios reference their register by **name** (the `riskRegister`
        field on `CreateRiskScenarioInput` and `RiskScenario`). Domains with
        multiple registers must specify a register name on create.
      properties:
        id:
          type: string
          description: The unique ID of the risk register.
        name:
          type: string
          description: |-
            The name of the risk register. This is the value used in the
            `riskRegister` field on risk-scenario create and update requests.
        description:
          type: string
          nullable: true
          description: Optional description of this register.
        registerType:
          $ref: '#/components/schemas/RestRiskRegisterType'
          description: |-
            Whether this is a scoped user-managed register or the system-managed
            enterprise register.
        creationDate:
          type: string
          format: date-time
          description: When this risk register was created.
        settings:
          $ref: '#/components/schemas/RiskRegisterSettings'
          description: Configuration that applies to the risk scenarios in this register.
      required:
        - id
        - name
        - description
        - registerType
        - creationDate
        - settings
      type: object
      additionalProperties: false
    PageInfo:
      description: Provides information about the pagination of a dataset.
      properties:
        endCursor:
          type: string
          nullable: true
          description: >-
            The cursor that points to the end of the current page, or null if
            there is no such cursor.
        hasNextPage:
          type: boolean
          description: Indicates if there is another page after the current page.
        hasPreviousPage:
          type: boolean
          description: Indicates if there is a page before the current page.
        startCursor:
          type: string
          nullable: true
          description: >-
            The cursor that points to the start of the current page, or null if
            there is no such cursor.
      required:
        - endCursor
        - hasNextPage
        - hasPreviousPage
        - startCursor
      type: object
      additionalProperties: false
    RestRiskRegisterType:
      type: string
      enum:
        - SCOPED
        - ENTERPRISE
    RiskRegisterSettings:
      properties:
        applicableCustomFields:
          items:
            type: string
          type: array
          description: >-
            Labels of the custom fields that apply to risk scenarios in this
            register.

            These are the labels accepted in the `customFields` field on
            risk-scenario

            create and update requests for this register. The enterprise
            register

            lists every custom field, since enterprise risks accept all of them.

            Empty if the organization doesn't have custom fields.
      required:
        - applicableCustomFields
      type: object
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

## Related topics

- [List risk scenarios](https://developer.vanta.com/api-reference/risk-scenarios/list-risk-scenarios.md)
- [Get risk register by ID](https://developer.vanta.com/api-reference/risk-registers/get-risk-register-by-id.md)
- [List risk snapshots for an audit](https://developer.vanta.com/api-reference/audits/list-risk-snapshots-for-an-audit.md)
- [List risks for an audit](https://developer.vanta.com/api-reference/audits/list-risks-for-an-audit.md)
- [List the enterprise risks mapped to a risk scenario](https://developer.vanta.com/api-reference/risk-scenarios/list-the-enterprise-risks-mapped-to-a-risk-scenario.md)
