Assessments

Get List of Assigned Assessments

Use this API to retrieve assessments assigned to the current user. The response includes assessments where the current user is an approver, respondent, or risk owner. The response returns a list of assessments up to the specified limit, along with totalCount and hasMore values to indicate whether additional assessments are available.

🗒 Things to Know

  • This endpoint only returns assessments assigned to the current user and cannot be used to retrieve assessments assigned to another user.
get/api/assessment/v2/assessments/assigned

Request

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

Query parameters

templateTypesstring[]

List of template types to filter assessments by. Defaults to all supported types if omitted.

textstring

Free-text search applied across assessment name and number.

filterstring

JSON-encoded array of search criteria objects, each with field, operation (one of =, !=, <, >, BW, IN, NOT IN, EMPTY), and value.

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.

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": [
    {
      "primaryInventoryNumber": "101; 102"
    }
  ],
  "totalCount": 137,
  "hasMore": true
}

Changes

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