---
title: "Get List of Assessments by Criteria"
method: POST
path: "/api/assessment/v3/assessments/list"
tags: ["Assessments"]
---

# Get List of Assessments by Criteria

`POST /api/assessment/v3/assessments/list`

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.

## Query parameters

- `templateTypes` string[]
- `assessmentStatuses` string[]
- `assessmentArchivalState` 'ALL' | 'ARCHIVED' | 'NON_ARCHIVED'
- `page` integer
- `size` integer
- `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'

## Request body

- PrivacyAutomationAssessmentAutomationAssessmentListRequest
  - `filterCriteria` PrivacyAutomationAssessmentAutomationSearchCriteriaInformation[] — List of reminder schedules to trigger notifications to configured users (respondents or approvers)
    - `field` string — The field name to apply the search criterion to
    - `operation` string — The operation to apply (eq, ne, gt, lt, in, between, etc.)
    - `value` object — The value to compare against. Can be a single value or a list of values depending on the operation
    - `toValue` object — The upper bound value for 'between' operations
  - `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.
  - `visibleColumns` string[], required
  - `adminOnlyView` boolean — Loads admin view

## Response `200`

OK

- PrivacyAutomationAssessmentAutomationAssessmentListResponseListAssessmentListViewResponseV2
  - `content` PrivacyAutomationAssessmentAutomationAssessmentListViewResponseV2[] — The assessment data content
    - `assessmentId` string, uuid — Unique identifier for the assessment
    - `number` integer — Assessment number used for reference
    - `name` string — Name of the assessment
    - `status` 'NOT_STARTED' | 'IN_PROGRESS' | 'UNDER_REVIEW' | 'COMPLETED' — Current status of the assessment
    - `result` string — Result of the assessment approval process
    - `orgGroupId` string, uuid — Unique identifier of the organization group this assessment belongs to
    - `orgGroupName` string — Name of the organization group this assessment belongs to
    - `assessmentCreatedBy` PrivacyAutomationAssessmentAutomationBasicUserEntityDetail
      - `id` string, uuid — Unique identifier of the user
      - `fullName` string — Full name of the user
      - `email` string — Email address of the user
      - `deleted` boolean — Flag indicating whether the user has been deleted
      - `assigneeType` string — Type of assignee (e.g., USER, GROUP)
    - `respondent` string
    - `respondents` PrivacyAutomationAssessmentAutomationBasicUserEntityDetail[]
      - `id` string, uuid — Unique identifier of the user
      - `fullName` string — Full name of the user
      - `email` string — Email address of the user
      - `deleted` boolean — Flag indicating whether the user has been deleted
      - `assigneeType` string — Type of assignee (e.g., USER, GROUP)
    - `approver` string
    - `creator` string — Name of the assessment creator
    - `approvers` PrivacyAutomationAssessmentAutomationBasicUserEntityDetail[]
      - `id` string, uuid — Unique identifier of the user
      - `fullName` string — Full name of the user
      - `email` string — Email address of the user
      - `deleted` boolean — Flag indicating whether the user has been deleted
      - `assigneeType` string — Type of assignee (e.g., USER, GROUP)
    - `deadline` string, date-time — Deadline date for assessment completion
    - `createDT` string, date-time — Date and time when the assessment was created
    - `createdBy` string, uuid — Unique identifier of the user who created the assessment
    - `completedOn` string, date-time — Date and time when the assessment was completed
    - `templateId` string, uuid — Unique identifier of the template used for this assessment
    - `templateRootVersionId` string, uuid — Unique identifier of the template root version
    - `templateName` string — Name of the template used for this assessment
    - `assessmentRiskLevelId` integer — Identifier of the assessment risk level
    - `assessmentRiskScore` number — Numerical score representing the assessment risk
    - `assessmentRiskLevelName` string — Name of the assessment risk level
    - `templateType` 'PIA' | 'VENDOR' | 'ITRM' | 'CONTROL' | 'INCIDENT' | 'EXCHANGE' | 'ESG' | 'DISCLOSURE' | 'DISCLOSURE_YOY' | 'ERM' | 'TPDD' | 'AIGOVERNANCE' — Type of the assessment template
    - `templateVersion` integer — Version number of the template
    - `editAllResponsesWhenInProgress` boolean — Flag indicating if all responses can be edited when assessment is in progress
    - `deletedDT` string, date-time — Date and time when the assessment was deleted (if applicable)
    - `deletedBy` string, uuid — Unique identifier of the user who deleted the assessment
    - `assessmentDeletedBy` PrivacyAutomationAssessmentAutomationBasicUserEntityDetail
      - `id` string, uuid — Unique identifier of the user
      - `fullName` string — Full name of the user
      - `email` string — Email address of the user
      - `deleted` boolean — Flag indicating whether the user has been deleted
      - `assigneeType` string — Type of assignee (e.g., USER, GROUP)
    - `pendingReviews` string — Comma-separated list of pending reviewer names
    - `pendingReviewers` PrivacyAutomationAssessmentAutomationBasicUserEntityDetail[] — Set of pending reviewer user details
      - `id` string, uuid — Unique identifier of the user
      - `fullName` string — Full name of the user
      - `email` string — Email address of the user
      - `deleted` boolean — Flag indicating whether the user has been deleted
      - `assigneeType` string — Type of assignee (e.g., USER, GROUP)
    - `submittedDT` string, date-time — Date and time when the assessment was submitted
    - `canResendLink` boolean — Flag indicating if assessment link can be resent
    - `inherentRiskScore` number — Numerical score representing the inherent risk
    - `inherentRiskLevelId` integer — Identifier of the inherent risk level
    - `inherentRiskLevelName` string — Name of the inherent risk level
    - `primaryRecordName` string — Name of the primary record associated with this assessment
    - `primaryRecordNumber` string — Reference number of the primary record
    - `targetRiskScore` number — Target numerical score for risk after mitigation
    - `targetRiskLevelId` integer — Identifier of the target risk level
    - `targetRiskLevelName` string — Name of the target risk level
    - `workflowId` string, uuid — Unique identifier of the workflow
    - `workflowStageId` string, uuid — Unique identifier of the current workflow stage
    - `workflowName` string — Name of the workflow
    - `approvalStageName` string — Name of the current approval stage
    - `badgeColor` string — Color code for the approval stage badge
    - `updatedDT` string, date-time — Date and time when the assessment was last updated
    - `assessmentDeleteStatus` 'ACTIVE' | 'SOFT_DELETED' | 'HARD_DELETED' — Status of assessment deletion
    - `attestationRequired` boolean — Flag indicating if attestation is required
    - `attestationCompleted` string, date-time — Date and time when attestation was completed
    - `finalComment` string — Final comment provided on the assessment
    - `openRiskCount` integer — Count of open risks associated with this assessment
    - `openInfoRequestCount` integer — Count of open information requests associated with this assessment
    - `tags` string — Comma-separated list of tags associated with the assessment
    - `redacted` boolean — Flag indicating if the assessment is redacted
  - `page` PrivacyAutomationAssessmentAutomationAssessmentPage
    - `number` integer — Current page number (zero-based)
    - `size` integer — Number of items per page
    - `totalElements` integer — Total number of elements across all pages
    - `totalPages` integer — Total number of pages available

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `429` — Too Many Requests. For more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).
- `500` — Internal Server Error

---

[API](https://skmtc.net/onetrust/apis/platform-access-management.md) · [All operations](https://skmtc.net/onetrust/apis/platform-access-management/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onetrust/platform-access-management/versions/21de3aa0b170/schema)