Skip to main content
GET
/
assessments
/
{id}
Get assessment with exercises
curl --request GET \
  --url https://app.edpire.com/api/v1/assessments/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "description": "<string>",
    "type": "quiz",
    "status": "draft",
    "share_code": "<string>",
    "settings": {
      "timeLimitMinutes": 123,
      "passingScorePercent": 123,
      "allowedAttempts": 123,
      "shuffleExercises": true,
      "showSolutions": "never"
    },
    "exercise_count": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "exercises": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "shared_context": "<unknown>",
        "questions": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "content_ast": {},
            "points": 123,
            "sequence_number": 123
          }
        ]
      }
    ]
  },
  "error": {
    "message": "<string>"
  },
  "meta": {}
}

Authorizations

Authorization
string
header
required

API key starting with edp_live_. Pass via Authorization: Bearer edp_live_xxx.

Scopes: read:assessments, write:assessments, read:results, write:submissions.

Path Parameters

id
string<uuid>
required

Assessment UUID

Response

Assessment with exercises and questions (no answer keys)

data
object
error
object
meta
object