API ReferencePartner

Get Assessments Info

Retrieves assessment details for a student under a specific project. Use this endpoint to check assessment status, results, and course recommendations for a given student email.

Authentication

X-Access-Tokenstring

Access token in the format <TokenId>:<TokenSecret>. Tokens are scoped to a specific project (college).

Request

This endpoint expects an object.
projectIdstringRequired

Project ID (college identifier)

emailstringRequired
Student email address

Response

List of assessments for the student
AssessmentIdstringOptional
Unique identifier for the assessment
StatusenumOptional

Current status of the assessment.

  • Completed — Student finished the assessment
  • Abandoned — Student did not finish the assessment
Recommendationslist of stringsOptional
List of recommended courses based on assessment results
AssessmentDurationstring or nullOptional

Time taken to complete the assessment (null if abandoned)

Errors

400
Bad Request Error
401
Unauthorized Error
429
Too Many Requests Error
500
Internal Server Error