Skip to main content
GET
Get exam details by ID.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required
Example:

"4340132f-50fa-4877-9ffa-e9b7ee59d51f"

Response

Successful Response

id
string<uuid>

Unique identifier of the exam.

Example:

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

examName
string

Name of the exam.

Example:

"Mock Test"

overallDuration
integer

Duration of the exam in minutes.

Example:

180

grade
integer

Class for which the exam is designed.

Example:

10

classSection
string | null

Section of the class, if applicable.

Example:

null

subject
integer

Subject ID associated with the exam.

Example:

1

examType
integer

Type of the exam.

Example:

1

examSet
string

Exam set information.

Example:

"N/A"

documents
object[]

List of documents associated with the exam.

createdAt
string<date-time>

Timestamp of exam creation.

Example:

"2024-12-23T12:50:39.786489Z"

modifiedAt
string<date-time>

Timestamp of the last modification.

Example:

"2024-12-26T06:52:14.633272Z"

examDate
string<date>

Date of the exam.

Example:

"2024-08-10"

isFinalPublish
boolean

Whether the exam is finalized for publication.

Example:

false

isProvisionalPublished
boolean

Whether the exam is provisionally published.

Example:

false