Get List of Linked Assessments by Entity ID

post

https://{hostname}/api/assessment/v2/entity-types/{entityTypeReference}/entities/{entityId}/assessments

Use this API to retrieve assessments associated with a specific entity. The response returns a list of linked assessments up to the specified limit, along with totalCount and hasMore values to indicate whether additional assessments are available.

🗒
Things to Know

The assessmentListViewType value is automatically derived from the entityTypeReference path parameter. Any assessmentListViewType value supplied in the request body is ignored.

The response returns a flat list of assessments and includes totalCount and hasMore values instead of paginated metadata.

Path Params

entityTypeReference

string

required

Entity type reference used to automatically determine the assessmentListViewType. Common built-in values include vendors, assets, processing-activities, entities, engagement, control-implementation, risks, issues, and incidents; tenants may also register additional custom entity types, so this is not an exhaustive, fixed list.

entityId

uuid

required

UUID of the entity to look up linked assessments for.

Query Params

text

string

Free-text search applied across assessment name and number.

parentEntityId

uuid

Parent entity ID

parentEntityType

string

Parent entity type name

limit

int32

1 to 100

Defaults to 20

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

sort

array of strings

Defaults to createdDate,desc

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

sort

Body Params

filterCriteria

array of objects

Criteria to filter the assessment list by. Each item filters on one field.

filterCriteria

assessmentListViewType

string

enum

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.

visibleColumns

array of strings

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

visibleColumns

adminOnlyView

boolean

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

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json

*/*

200OK

429Too Many Requests. For more information, see API Rate Limits.