Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Assessments

Get List of Assessments

Use this API to retrieve a list of all assessments with basic assessment details. The response will include details such as the assessment ID, number, stage, result, and associated organization.

🗒 Things to Know

  • All assessments regardless of their stage are returned in the response by default.

  • The assessments can be filtered by stage using the assessmentStatuses query parameter.

  • The size and page query parameters can be used to paginate the response (list of assessments). The size parameter defines the number of assessments to be returned in each page. The page parameter defines the page number. The first page and default page is page number 0. The size parameter is optional and default value is 20, but cannot exceed 2000. If you input a value greater than 2000, then 2000 will be used for the size.

get/api/assessment/v2/assessments

Query parameters

templateTypesstring[]

List of template types to filter assessments by. Available options:

  • PIA (PIA & DPIA Automation)
  • VENDOR (Third-Party Risk Management)
  • ITRM (IT & Security Risk Management)
  • CONTROL (Risk and Controls)
  • INCIDENT (Incident Management)
  • EXCHANGE (Third-Party Risk Exchange)
  • ESG (ESG Program Reporting)
  • DISCLOSURE (Disclosure Management)
  • DISCLOSURE_YOY (Year Over Year Disclosures)
  • ERM (Enterprise Risk Management)
  • TPDD (Third-Party Due Diligence)
  • AIGOVERNANCE (AI Governance)
assessmentStatusesstring[]

List of assessment statuses to filter by

assessmentArchivalState'ALL' | 'ARCHIVED' | 'NON_ARCHIVED'

Filter by archival state

pageinteger

Results page to be retrieved (0..N). Example- '?page=1

sizeinteger

Number of records per page (1…N).

sort'number,asc' | 'number,desc' | 'status,asc' | 'status,desc' | 'createdDate,asc' | 'createdDate,desc' | 'name,asc' | 'name,desc' | 'result,asc' | 'result,desc' | 'orgGroupName,asc' | 'orgGroupName,desc' | 'deadline,asc' | 'deadline,desc' | 'openRiskCount,asc' | 'openRiskCount,desc' | 'openInfoRequestCount,asc' | 'openInfoRequestCount,desc'

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Response

OK

Example response

{
  "content": {
    "assessmentId": "123e4567-e89b-12d3-a456-426614174000",
    "number": 12345,
    "name": "Annual Security Review",
    "status": "In Progress",
    "state": "Active",
    "resultId": "123e4567-e89b-12d3-a456-426614174001",
    "resultName": "Approved with Conditions",
    "orgGroupName": "Finance Department",
    "createDt": "2025-07-01T10:30:00Z",
    "templateName": "Security Assessment Template v2",
    "templateId": "123e4567-e89b-12d3-a456-426614174002",
    "templateRootVersionId": "123e4567-e89b-12d3-a456-426614174003",
    "primaryInventoryDetails": {
      "primaryInventoryName": "Server Infrastructure",
      "primaryInventoryId": "123e4567-e89b-12d3-a456-426614174000",
      "primaryInventoryNumber": 10042
    },
    "residualRiskScore": 3.5,
    "openRiskCount": 5,
    "inherentRiskScore": 7.2,
    "targetRiskScore": 2,
    "lastUpdated": "2025-07-23T15:30:45Z"
  },
  "page": {
    "size": 20,
    "totalElements": 100,
    "totalPages": 5
  }
}