Skip to main content
GET
Get assessment details

Authorizations

x-api-key
string
header
required

API key for authentication. Format: ak_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Path Parameters

assessmentId
string<uuid>
required

Unique identifier of the assessment

Response

Successful response

id
string<uuid>

Unique identifier of the assessment

name
string

Name of the assessment

defaultQuestionFormat
enum<string>

Default format for questions

Available options:
text,
audio,
video,
mixed
defaultAnswerFormat
enum<string>

Default format for answers

Available options:
text,
audio,
video,
mixed
languages
string[]

Languages used in the assessment

questionCount
integer

Number of questions in the assessment

inviteCount
integer

Number of invites sent for this assessment

createdAt
string<date-time>

When the assessment was created

updatedAt
string<date-time>

When the assessment was last updated

totalPoints
integer

Total points available in the assessment