Risks

List risks

GET
/organizations/{organizationId}/risks

Returns the risks in the organization risk register.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Path Parameters

organizationId*string

Query Parameters

id?string|array<string>
status?string

Value in

  • "open"
  • "closed"
  • "archived"
category?string
Lengthlength <= 64
ownerUserId?string
treatmentStrategy?string

Value in

  • "untreated"
  • "mitigate"
  • "accept"
  • "transfer"
  • "avoid"
controlId?string
vendorId?string
search?string
Lengthlength <= 256
limit?integer
Range1 <= value <= 1000
offset?integer
Range0 <= value <= 9007199254740991

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/organizations/string/risks"
{  "items": [    {      "id": "string",      "organizationId": "string",      "riskTemplateId": "string",      "key": "string",      "title": "string",      "description": "string",      "category": "string",      "ownerUserId": "string",      "status": "open",      "inherentLikelihood": 0,      "inherentImpact": 0,      "inherentScore": 0,      "inherentBand": {        "label": "string",        "min": 0,        "max": 0,        "color": "string"      },      "treatmentStrategy": "untreated",      "treatmentRationale": "string",      "treatmentTargetDate": null,      "treatmentCompletedDate": null,      "residualLikelihood": 0,      "residualImpact": 0,      "residualScore": 0,      "residualBand": {        "label": "string",        "min": 0,        "max": 0,        "color": "string"      },      "controlIds": [        "string"      ],      "vendorId": "string",      "affectedRecords": [        {          "type": "dataSystem",          "id": "string"        }      ],      "ruleId": "string",      "reviewFrequency": "annual",      "lastReviewedAt": null,      "nextReviewDueAt": null,      "dateCreated": null,      "dateUpdated": null,      "property1": null,      "property2": null    }  ],  "total": 0}