Skip to main content
GET
Get an exam

Authorizations

X-API-Key
string
header
required

Your institute's API key, vak_eval_ followed by 48 hex characters. An institute admin creates keys in the dashboard under Settings -> Integrations -> API keys.

Path Parameters

examId
string<uuid>
required

Exam id (UUID).

Query Parameters

include
string

Comma-separated: questions, candidates, choice_groups, stats, rubric.

Example:

"questions,stats"

Response

OK

id
string
status
string
mode
string
title
string
external_ref
string
conducted_on
string
subject
string
level
string
board
string
answer_language
string
feedback_language
string
instructions
string
blind
boolean
total_marks
number<double>
paper_max
number<double>
question_count
integer<int32>
dashboard_url
string
questions
object[]
choice_groups
object[]
candidates
object[]
rubric
object
quote
object
stats
object
warnings
object[]
opened_at
string
finalized_at
string
created_at
string
updated_at
string
class
string