ONonetrust
Assessments

Search Assessments

Use this API to search assessments across the tenant based on template type and filter criteria. The response returns a list of matching assessments up to the specified limit, along with totalCount and hasMore values to indicate whether additional assessments are available.

post/api/assessment/v2/assessments/search

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/assessment/v2/assessments/search
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: ASSESSMENT_READ, ASSESSMENT

Query parameters

templateTypesstring[] required

List of template types to filter assessments by.

textstring

Free-text search applied across assessment name and number.

limitinteger

Maximum number of assessments to return. Defaults to 20 and is capped at 100 regardless of the value supplied.

sortstring[]

Repeat the sort query parameter for multiple criteria in property,asc|desc format. Defaults to createdDate,desc.

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'

View type to load assessments for. Ignored by the linked assessments endpoint, which derives it from entityTypeReference. Defaults to ASSESSMENT_AUTOMATION_LIST_VIEW on the search endpoint.

visibleColumnsstring[]

Column names to include in the response. Omit or send an empty list to use the default set of columns.

adminOnlyViewboolean

Loads the admin view. Used by the search endpoint only.

Example request

{
  "filterCriteria": [
    {
      "field": "status",
      "operation": "IN",
      "value": [
        "IN_PROGRESS",
        "UNDER_REVIEW"
      ]
    }
  ],
  "assessmentListViewType": "ASSESSMENT_AUTOMATION_LIST_VIEW",
  "visibleColumns": [
    "number",
    "assessmentName",
    "assessmentStatus",
    "templateName",
    "createdDate"
  ]
}

Response

OK

totalCountinteger

Total number of assessments matching the given criteria, independent of the limit applied

hasMoreboolean

Whether more assessments exist beyond the ones returned in content, i.e. totalCount > content.size()

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",
      "completedBy": "123e4567-e89b-12d3-a456-426614174002",
      "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",
      "assessmentDetailUrl": "https://example.com/assessments/123e4567-e89b-12d3-a456-426614174000",
      "recordAdminId": "123e4567-e89b-12d3-a456-426614174008"
    }
  ],
  "totalCount": 137,
  "hasMore": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.