Skip to main content
GET
/
assessments
List risk assessments
curl --request GET \
  --url https://api.gominerva.com/risk-assessments/v2/assessments \
  --header 'Authorization: <api-key>'
{
  "status": 200,
  "msg": "OK",
  "result": {}
}

Authorizations

​
Authorization
string
header
required

Use the format Api-Key YOUR_API_KEY.

Query Parameters

​
status
string

Comma-separated assessment statuses.

Example:

"running,waiting_for_user,ready_for_review"

​
task_status
string

Comma-separated task statuses.

Example:

"requires_review,incomplete"

​
search
string

Case-insensitive search string.

​
subject_search
string

Search assessment subjects by name.

​
outcome
string

Search conclusion outcome.

​
sort_by
string

Supported values include assessment, title, subjects, status, updated_at, concluded_at, created_at, and outcome.

Example:

"updated_at"

​
sort_direction
enum<string>

Sort direction.

Available options:
asc,
desc
​
limit
integer
default:50

Maximum records to return.

​
offset
integer
default:0

Offset for page-style pagination.

Response

OK

​
status
integer
required
Example:

200

​
msg
string
required
Example:

"OK"

​
result
object
required