Assessments

Use this endpoint to return the Assessments for Reports.

Note: Listen to the report.updated webhook to determine when an Assessment has been applied to a report.

Operations

List existing Assessments

Returns Assessments for an existing Report.

Security

basic_auth

report_idstringrequired

The ID of the associated Report.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://docs.checkr.com/_mock/apis/openapi/reports/{report_id}/assessments'

List of Assessments

Bodyapplication/json

dataArray of objects(Assessment)

objectstring

Value:"list"

countinteger

The total number of assessments for the specified Report.

Example:1

Response

{
  "data": [
    { … }
  ],
  "object": "list",
  "count": 1
}