Skip to content

Get a key risk indicator by id

GET
/risk-indicators/{id}
curl --request GET \
--url https://api.vendorica.com/v1/risk-indicators/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>'
id
required
string format: uuid

Success

Media typeapplication/json
object
success
required
boolean
data
required
object
id
required
string format: uuid
organizationId
required
string format: uuid
displayId
required
string
name
required
string
description
required
string | null
categoryId
required
string | null format: uuid
ownerUserId
required
string | null format: uuid
sourceKind
required
string
Allowed values: manual test_results drift_events vendor_rating incidents report_dataset
sourceConfig
required
object
key
additional properties
unit
required
string
Allowed values: count percent score days currency
direction
required
string
Allowed values: higher_is_worse lower_is_worse
amberThreshold
required
number
redThreshold
required
number
cadence
required
string
Allowed values: manual daily weekly monthly quarterly
measurementWindowDays
required
integer | null
latestValue
required
number | null
latestStatus
required
string
Allowed values: unknown green amber red
latestMeasuredAt
required
string | null format: date-time
nextMeasurementAt
required
string | null format: date-time
isActive
required
boolean
isArchived
required
boolean
categoryName
required
string | null
ownerEmail
required
string | null
scenarioIds
required
Array<string>
createdBy
required
string | null format: uuid
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
timestamp
required
string format: date-time
requestId
string
message
string
Example
{
"success": true,
"data": {
"id": "5ce31c5d-9885-498d-8869-ea8aacbc3d8a",
"organizationId": "ba3b1248-74fd-4a7e-8885-c2c70d9198f9",
"displayId": "string",
"name": "string",
"description": "string",
"categoryId": "90d96211-1935-43e9-890c-495e485778ae",
"ownerUserId": "36eaa177-e85c-4b2f-8517-f64414b8a6c0",
"sourceKind": "manual",
"sourceConfig": {},
"unit": "count",
"direction": "higher_is_worse",
"amberThreshold": 1,
"redThreshold": 1,
"cadence": "manual",
"measurementWindowDays": 1,
"latestValue": 1,
"latestStatus": "unknown",
"latestMeasuredAt": "2026-08-19T09:41:12.004Z",
"nextMeasurementAt": "2026-08-19T09:41:12.004Z",
"isActive": true,
"isArchived": true,
"categoryName": "string",
"ownerEmail": "string",
"scenarioIds": [
"2d3c79d4-0c33-4be2-8689-f333b229df95"
],
"createdBy": "47d7ecff-15ea-4247-837a-c10cc23ddf98",
"createdAt": "2026-08-19T09:41:12.004Z",
"updatedAt": "2026-08-19T09:41:12.004Z"
},
"timestamp": "2026-08-19T09:41:12.004Z",
"requestId": "req_01J5X8ZC3K4T7Q9M2W6B0N1V4H",
"message": "string"
}

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"
}

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"
}

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"
}

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"
}

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"
}