Skip to content
Vendorica Developer Docs

List risk scenarios

GET
/risk-scenarios
curl --request GET \
  --url https://api.vendorica.com/v1/risk-scenarios \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
success
required
boolean
data
required
Array<object>
object
id
required
string format: uuid
organizationId
required
string format: uuid
registerId
required
string format: uuid
displayId
required
string
title
required
string
description
required
string | null
categoryId
required
string | null format: uuid
riskType
required
Array<string> | null
Allowed values: confidentiality integrity availability
inherentLikelihood
required
integer | null
inherentImpact
required
integer | null
residualLikelihood
required
integer | null
residualImpact
required
integer | null
lifecycleStatus
required
string
Allowed values: open mitigating accepted closed
approvalStatus
required
string
Allowed values: draft needs_review pending_approval approved
isArchived
required
boolean
treatment
required
string | null
Allowed values: mitigate accept transfer avoid
treatmentPlan
required
string | null
ownerUserId
required
string | null format: uuid
targetResolutionDate
required
string | null
vendorId
required
string | null format: uuid
businessFunctionId
required
string | null format: uuid
controlId
required
string | null format: uuid
sourceTemplateId
required
string | null format: uuid
businessUnitIds
required
Array<string>
createdBy
required
string | null format: uuid
createdAt
required
string | null format: date-time
updatedAt
required
string | null format: date-time
inherentScore
required
integer | null
residualScore
required
integer | null
timestamp
required
string format: date-time
requestId
string
message
string
pagination
object
page
required
integer
limit
required
integer
total
required
integer
totalPages
required
integer
Example
{
  "success": true,
  "data": [
    {
      "id": "0461f0ce-b22e-4124-8585-0065f15f98b3",
      "organizationId": "5c7ee077-10bb-482f-82eb-cd4459341bc0",
      "registerId": "829b8b39-d5dc-4de1-8b9c-3ac688f07f66",
      "displayId": "string",
      "title": "string",
      "description": "string",
      "categoryId": "7f1a6b66-7a97-4e6c-8acb-b8bdd7b3cb3b",
      "riskType": [
        "confidentiality"
      ],
      "inherentLikelihood": 1,
      "inherentImpact": 1,
      "residualLikelihood": 1,
      "residualImpact": 1,
      "lifecycleStatus": "open",
      "approvalStatus": "draft",
      "isArchived": true,
      "treatment": "mitigate",
      "treatmentPlan": "string",
      "ownerUserId": "2aa5f20e-2f3c-48e4-8282-03a553abb673",
      "targetResolutionDate": "string",
      "vendorId": "4e4fe7a8-f1c9-409e-8d81-0727f51e3c19",
      "businessFunctionId": "3b151b60-643a-4b46-8c78-ed9f3d5e0b01",
      "controlId": "944efe45-bf5a-49c5-8122-22b27ebca482",
      "sourceTemplateId": "1f1ace07-fc32-41df-8f36-dd54b35e64f0",
      "businessUnitIds": [
        "5f7c048b-d93b-43ab-8019-2178838fb634"
      ],
      "createdBy": "df9d971e-2114-4114-8ade-5735ad034223",
      "createdAt": "2026-08-19T09:41:12.004Z",
      "updatedAt": "2026-08-19T09:41:12.004Z",
      "inherentScore": 1,
      "residualScore": 1
    }
  ],
  "timestamp": "2026-08-19T09:41:12.004Z",
  "requestId": "req_01J5X8ZC3K4T7Q9M2W6B0N1V4H",
  "message": "string",
  "pagination": {
    "page": 1,
    "limit": 1,
    "total": 1,
    "totalPages": 1
  }
}

400

Section titled “400”

Validation error

Media typeapplication/json
object
success
required
boolean
error
required
string
code
required
string
details
timestamp
required
string format: date-time
requestId
string
Example
{
  "success": false,
  "error": "Bad request",
  "code": "BAD_REQUEST",
  "timestamp": "2026-08-19T09:41:12.004Z",
  "requestId": "req_01J5X8ZC3K4T7Q9M2W6B0N1V4H"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
success
required
boolean
error
required
string
code
required
string
details
timestamp
required
string format: date-time
requestId
string
Example
{
  "success": false,
  "error": "Unauthorized",
  "code": "UNAUTHORIZED",
  "timestamp": "2026-08-19T09:41:12.004Z",
  "requestId": "req_01J5X8ZC3K4T7Q9M2W6B0N1V4H"
}

403

Section titled “403”

Forbidden — missing scope

Media typeapplication/json
object
success
required
boolean
error
required
string
code
required
string
details
timestamp
required
string format: date-time
requestId
string
Example
{
  "success": false,
  "error": "Forbidden",
  "code": "FORBIDDEN",
  "timestamp": "2026-08-19T09:41:12.004Z",
  "requestId": "req_01J5X8ZC3K4T7Q9M2W6B0N1V4H"
}

404

Section titled “404”

Not found

Media typeapplication/json
object
success
required
boolean
error
required
string
code
required
string
details
timestamp
required
string format: date-time
requestId
string
Example
{
  "success": false,
  "error": "Resource not found",
  "code": "NOT_FOUND",
  "timestamp": "2026-08-19T09:41:12.004Z",
  "requestId": "req_01J5X8ZC3K4T7Q9M2W6B0N1V4H"
}

429

Section titled “429”

Rate limit exceeded

Media typeapplication/json
object
success
required
boolean
error
required
string
code
required
string
details
timestamp
required
string format: date-time
requestId
string
Example
{
  "success": false,
  "error": "Too many requests",
  "code": "TOO_MANY_REQUESTS",
  "timestamp": "2026-08-19T09:41:12.004Z",
  "requestId": "req_01J5X8ZC3K4T7Q9M2W6B0N1V4H"
}