Skip to main content
GET
List exam answer sheets
Use this call to find an answer sheet’s id, and to watch upload and evaluation progress for a whole class in one request.

Rules

  • Sheets come back newest first. This list is not paginated, so an exam with many students returns them all.
  • studentName matches part of a name, ignoring case. studentId, teacherId, instituteId, and parentId match exactly.
  • documents[].status shows each file’s progress: 0 Open, 1 In Progress, 2 Completed, 3 Failed.
An exam ID that does not exist returns 200 with an empty data array, not 404.

Authorizations

Authorization
string
header
required

Access token from Get an access token. A missing, invalid, or expired token returns 403.

Path Parameters

examId
string<uuid>
required

The exam id returned by Create an exam. Write it in lowercase: this path only matches lowercase hexadecimal characters and hyphens.

Example:

"d19e6868-98dd-4274-a2a5-4a616dd93ea7"

Query Parameters

studentId
string

Keep sheets with exactly this studentId.

Example:

"S-2043"

instituteId
string

Keep sheets with exactly this instituteId.

teacherId
string

Keep sheets with exactly this teacherId.

studentName
string

Keep sheets whose studentName contains this text, ignoring case.

parentId
string

Keep sheets with exactly this parentId.

Response

The exam's answer sheets. data is empty when the exam has none, and when the exam ID does not exist.

data
object[]