Skip to main content
GET
/
assessments
/
{assessmentId}
Get assessment details
curl --request GET \
  --url https://alfaone.app/api/v1/assessments/{assessmentId} \
  --header 'x-api-key: <api-key>'
{ "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "name": "<string>", "languages": [ "<string>" ], "questionCount": 123, "inviteCount": 123, "createdAt": "2023-11-07T05:31:56Z", "updatedAt": "2023-11-07T05:31:56Z", "totalPoints": 123 }

Documentation Index

Fetch the complete documentation index at: https://v4-docs.alfaone.app/llms.txt

Use this file to discover all available pages before exploring further.

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