Sign in

v1

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

Get List of Assessments by Criteria

Use this API to retrieve list of all the assessments or assessments by filter criteria like Approver Ids, Respondent Ids, Template Ids etc. The response will include details such as the assessment ID, number, stage, result, primary record, 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, templateTypes, assessmentArchivalState query parameter. Other than these commonly used filters, request body can be used to filter assessments by approver Ids, respondent Ids, template Ids, workflow stage name.

post/api/assessment/v3/assessments/list

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 assessments by

assessmentArchivalState'ALL' | 'ARCHIVED' | 'NON_ARCHIVED'
Example:NON_ARCHIVED

Filter assessments by their archival state. Use ALL to include both archived and non-archived assessments, ARCHIVED to include only archived assessments, or NON_ARCHIVED to include only non-archived assessments.

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.

Request body

assessmentListViewType'VENDOR_VIEW' | 'CONTROL_VIEW' | 'ASSESSMENT_AUTOMATION_LIST_VIEW' | 'DATA_MAPPING_LIST_VIEW' | 'ITRM_LIST_VIEW' | 'INCIDENT_LIST_VIEW' | 'ESG_LIST_VIEW' | 'ENGAGEMENT_LIST_VIEW' | 'EXCHANGE_LIST_VIEW' | 'DISCLOSURE_LIST_VIEW' | 'EMPLOYEE_DISCLOSURE_LIST_VIEW' | 'TPDD_LIST_VIEW' | 'GENERAL_LIST'

Load assessments for corresponding view types. Optional for linked assessment APIs (determined from entity type reference). Required for general list APIs.

visibleColumnsstring[] required
adminOnlyViewboolean

Loads admin view

Example request

{
  "filterCriteria": [
    {
      "reminderType": "DEADLINE",
      "daysBeforeDeadline": 7,
      "userTypes": [
        "RESPONDENT"
      ]
    }
  ],
  "assessmentListViewType": "ASSESSMENT_AUTOMATION_LIST_VIEW",
  "visibleColumns": [
    "number"
  ]
}

Response

OK

Example response

{
  "content": [
    {
      "assessmentId": "123e4567-e89b-12d3-a456-426614174000",
      "number": 1001,
      "name": "GDPR Compliance Assessment",
      "status": "IN_PROGRESS",
      "result": "APPROVED",
      "orgGroupId": "123e4567-e89b-12d3-a456-426614174001",
      "orgGroupName": "Marketing Department",
      "creator": "John Doe",
      "deadline": "2025-12-31T23:59:59Z",
      "createDT": "2025-01-15T10:30:00Z",
      "createdBy": "123e4567-e89b-12d3-a456-426614174002",
      "completedOn": "2025-06-15T14:45:00Z",
      "templateId": "123e4567-e89b-12d3-a456-426614174003",
      "templateRootVersionId": "123e4567-e89b-12d3-a456-426614174004",
      "templateName": "GDPR PIA Template",
      "assessmentRiskLevelId": 3,
      "assessmentRiskScore": 7.5,
      "assessmentRiskLevelName": "HIGH",
      "templateType": "PIA",
      "templateVersion": 2,
      "editAllResponsesWhenInProgress": true,
      "deletedDT": "2025-07-20T09:15:00Z",
      "deletedBy": "123e4567-e89b-12d3-a456-426614174005",
      "pendingReviews": "Charlie Brown, Diana Prince",
      "submittedDT": "2025-05-10T16:20:00Z",
      "canResendLink": true,
      "inherentRiskScore": 8.2,
      "inherentRiskLevelId": 4,
      "inherentRiskLevelName": "CRITICAL",
      "primaryRecordName": "Customer Database",
      "primaryRecordNumber": "DB-2025-001",
      "targetRiskScore": 3.5,
      "targetRiskLevelId": 2,
      "targetRiskLevelName": "MEDIUM",
      "workflowId": "123e4567-e89b-12d3-a456-426614174006",
      "workflowStageId": "123e4567-e89b-12d3-a456-426614174007",
      "workflowName": "Standard PIA Approval Process",
      "approvalStageName": "Legal Review",
      "badgeColor": "#4287f5",
      "updatedDT": "2025-07-01T11:25:30Z",
      "assessmentDeleteStatus": "SOFT_DELETED",
      "attestationRequired": true,
      "attestationCompleted": "2025-06-20T14:30:00Z",
      "finalComment": "All requirements have been met with appropriate controls in place.",
      "openRiskCount": 3,
      "openInfoRequestCount": 2,
      "tags": "GDPR,High Priority,Marketing"
    }
  ],
  "page": {
    "size": 20,
    "totalElements": 100,
    "totalPages": 5
  }
}