Skip to main content
GET
/
v1
/
risks
Get all risks
curl --request GET \
  --url http://localhost:3333/v1/risks \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "rsk_abc123def456",
      "title": "Data breach vulnerability in user authentication system",
      "description": "Weak password requirements could lead to unauthorized access to user accounts",
      "category": "technology",
      "status": "open",
      "likelihood": "possible",
      "impact": "major",
      "treatmentStrategy": "mitigate",
      "assigneeId": "mem_abc123def456",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "count": 15,
  "authType": "api-key",
  "authenticatedUser": {
    "id": "usr_def456ghi789",
    "email": "user@example.com"
  }
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication

Query Parameters

​
title
string

Search by title (case-insensitive contains)

Example:

"data breach"

​
page
number
default:1

Page number (1-indexed)

Required range: x >= 1
Example:

1

​
perPage
number
default:50

Number of items per page

Required range: 1 <= x <= 250
Example:

50

​
sort
enum<string>
default:createdAt

Sort by field

Available options:
createdAt,
updatedAt,
title,
status
​
sortDirection
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
​
status
enum<string>

Filter by status

Available options:
open,
pending,
closed,
archived
​
category
enum<string>

Filter by category

Available options:
customer,
fraud,
governance,
operations,
other,
people,
regulatory,
reporting,
resilience,
technology,
vendor_management
​
department
enum<string>

Filter by department

Available options:
none,
admin,
gov,
hr,
it,
itsm,
qms
​
assigneeId
string

Filter by assignee member ID

Example:

"mem_abc123def456"

Response

Risks retrieved successfully

​
data
object[]
​
count
number

Total number of risks

Example:

15

​
authType
enum<string>

How the request was authenticated

Available options:
api-key,
session
​
authenticatedUser
object

User information (only for session auth)