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.

Query Params
templateTypes
array of strings

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)
templateTypes
assessmentStatuses
array of strings

List of assessment statuses to filter assessments by

assessmentStatuses
string
enum
Defaults to 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.

Allowed:
int32
β‰₯ 0
Defaults to 0

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

int32
1 to 2000
Defaults to 20

Number of records per page (1…N).

string
enum
Defaults to createdDate,desc

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

Body Params
filterCriteria
array of objects

List of reminder schedules to trigger notifications to configured users (respondents or approvers)

filterCriteria
string
enum
required

Load assessments for corresponding view types

visibleColumns
array of strings
required
length between 1 and 2147483647
visibleColumns*
boolean
Defaults to false

Loads admin view

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language
Credentials
OAuth2
Missing 3 required scopes
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*