# Get Risk Register

Endpoint: GET /{riskRegisterId}
Version: 1.0
Security: oauth2

## Path parameters:

  - `riskRegisterId` (string, required)
    Unique ID of the risk register.

## Response 200 fields (application/json):

  - `id` (string, required)
    The unique identifier for the risk register
    Example: "9f25da4f-1532-11ee-a87d-8e36b9d27de7"

  - `orgId` (string, required)
    The unique identifier for the organization
    Example: "ce83e3cd-5199-11ee-a644-522476618ae8"

  - `name` (string, required)
    Name of the risk register
    Example: "Enterprise Risk Register"

  - `description` (string,null)
    Description of the risk register
    Example: "Risks tracked across the enterprise compliance program."

  - `riskRegisterType` (string, required)
    The type of risk register. A standard register holds the risks the organization is actively managing. An intake register collects proposed risks submitted for evaluation before they are accepted into a standard register.
    Enum: "standard", "intake"

  - `usesAdvancedMitigation` (boolean,null)
    Flag indicating whether the register calculates residual risk from the mitigation and health of the controls linked to each risk. Always false for an intake register
    Example: true

  - `customRiskScales` (object,null)
    The likelihood, impact and inherent risk scales the register scores its risks against. Null for an intake register
    Example: {"likelihood":[{"name":"Very Low","value":1,"color":"#EDF9F2"},{"name":"Low","value":2,"color":"#91D4BC"},{"name":"Moderate","value":5,"color":"#FFB75D"},{"name":"High","value":8,"color":"#FF8C00"},{"name":"Very High","value":10,"color":"#C2533B"}],"impact":[{"name":"Very Low","value":1,"color":"#EDF9F2"},{"name":"Low","value":2,"color":"#91D4BC"},{"name":"Moderate","value":5,"color":"#FFB75D"},{"name":"High","value":8,"color":"#FF8C00"},{"name":"Very High","value":10,"color":"#C2533B"}],"inherentRisk":[{"name":"Very Low","value":1,"color":"#EDF9F2","inherentRiskThreshold":1},{"name":"Low","value":2,"color":"#91D4BC","inherentRiskThreshold":10},{"name":"Moderate","value":5,"color":"#FFB75D","inherentRiskThreshold":40},{"name":"High","value":8,"color":"#FF8C00","inherentRiskThreshold":64},{"name":"Very High","value":10,"color":"#C2533B","inherentRiskThreshold":100}]}

  - `customRiskScales.likelihood` (array)
    Example: [{"name":"Very Low","value":1,"color":"#EDF9F2"},{"name":"Low","value":2,"color":"#91D4BC"},{"name":"Moderate","value":5,"color":"#FFB75D"},{"name":"High","value":8,"color":"#FF8C00"},{"name":"Very High","value":10,"color":"#C2533B"}]

  - `customRiskScales.likelihood.name` (string)
    Name of the likelihood level

  - `customRiskScales.likelihood.value` (integer)
    Value of the likelihood level

  - `customRiskScales.likelihood.color` (string)
    Color associated with the likelihood level

  - `customRiskScales.impact` (array)
    Example: [{"name":"Very Low","value":1,"color":"#EDF9F2"},{"name":"Low","value":2,"color":"#91D4BC"},{"name":"Moderate","value":5,"color":"#FFB75D"},{"name":"High","value":8,"color":"#FF8C00"},{"name":"Very High","value":10,"color":"#C2533B"}]

  - `customRiskScales.impact.name` (string)
    Name of the impact level

  - `customRiskScales.impact.value` (integer)
    Value of the impact level

  - `customRiskScales.impact.color` (string)
    Color associated with the impact level

  - `customRiskScales.inherentRisk` (array)
    Example: [{"name":"Very Low","value":1,"color":"#EDF9F2","inherentRiskThreshold":1},{"name":"Low","value":2,"color":"#91D4BC","inherentRiskThreshold":10},{"name":"Moderate","value":5,"color":"#FFB75D","inherentRiskThreshold":40},{"name":"High","value":8,"color":"#FF8C00","inherentRiskThreshold":64},{"name":"Very High","value":10,"color":"#C2533B","inherentRiskThreshold":100}]

  - `customRiskScales.inherentRisk.name` (string)
    Name of the inherent risk level

  - `customRiskScales.inherentRisk.value` (integer)
    Value of the inherent risk level

  - `customRiskScales.inherentRisk.color` (string)
    Color associated with the inherent risk level

  - `customRiskScales.inherentRisk.inherentRiskThreshold` (integer)
    Threshold value for the inherent risk level

  - `defaultRiskOwnerId` (string,null)
    The unique identifier for the user assigned as the owner of risks submitted to an intake register. Null for a standard register

  - `allowedEmailDomains` (array,null)
    Email domains permitted to submit proposed risks to an intake register. Empty for a standard register
    Example: []

  - `status` (string, required)
    The status of the object.
    Enum: "active", "archived", "pending", "canceled", "deleted", "closed"

  - `createdBy` (string, required)
    The unique identifier of the user who created the risk register
    Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"

  - `createdOn` (string, required)
    The date the risk register was created (ISO-8601 format)
    Example: "2023-09-12T18:26:10.005365Z"

  - `updatedBy` (string, required)
    The unique identifier of the user who last updated the risk register
    Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"

  - `updatedOn` (string, required)
    The date the risk register was last updated (ISO-8601 format)
    Example: "2023-09-12T18:26:10.005365Z"

  - `permissions` (array)
    List of permissions the API user has on the risk register
    Example: []


## Response 401 fields

## Response 403 fields

## Response 404 fields