Skip to main content
GET
/
api
/
risk_assessment
Retrieve a list of risk assessments
curl --request GET \
  --url http://localhost/api/api/risk_assessment \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "results": [
    {
      "id": 123,
      "daily_score": 0,
      "true_hit_date": "2023-11-07T05:31:56Z",
      "rules_affected": [
        123
      ],
      "active_timestamp": "2023-12-25",
      "demerit": "<string>"
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Authorizations

​
Authorization
string
header
required

JWT token obtained from AWS Cognito or custom authentication service

Query Parameters

​
client_subject_id
string
​
limit
integer

Number of results to return per page.

​
max_date
string<date-time>
​
min_date
string<date-time>
​
offset
integer

The initial index from which to return the results.

Response

200 - application/json
​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=400&limit=100"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=200&limit=100"