Developers
Exams

List exam questions

GET/products/{product_id}/exams/{exam_id}/questions

The correct field of each alternative is included only when the current credentials have the exams.read_answer_key permission; otherwise, the field is omitted.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

product_id*string
exam_id*string

Query Parameters

limit?integer
Range1 <= value <= 200
cursor?string
sort?string

Value in

  • "id"
  • "-id"
deleted?boolean

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/products/string/exams/string/questions"
{  "data": [    {      "alternatives": [        {          "correct": true,          "id": "string",          "text": "string"        }      ],      "created_at": "2019-08-24T14:15:22Z",      "deleted": true,      "exam_id": "string",      "format": "multiple_choice",      "id": "string",      "image": "string",      "object": "exam_question",      "position": 0,      "revision": "string",      "text": "string",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Retrieve the answers for an exam attempt GET

Returns the answers the user submitted in the attempt. Requires the `exams.attempts.read_answers` permission; `exams.attempts.read` alone does not grant access to this operation.

Create an exam question POST

Adds a question to the exam. The question must have at least two alternatives, and at least one of them must be marked as correct. Questions are single-choice: if more than one alternative is marked as correct, only the first one is treated as correct.