Documentation Index

Fetch the complete documentation index at: https://help.cirrusassessment.com/llms.txt

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

Get Available Assessments

Prev Next

Get Assessment

Result of Get Assessment call

This call will get all assessments with an external ID, that have a status Live and Published.

Get /assessments/

Header

Name Data Type Description
Content-type: application/json for all requests
Authorization: EAPI {token} for all requests

Request Parameters

Parameters indicated with a * are mandatory

Parameter Type Description
purposes String(50) Filter of assessments by purposes, It is used as the get parameter of request, For example “?purposes=1” will return all Summative assessments, “?purposes=1,2” will return all Summative and Formative assessments
Possible options:
Summative=1
Formative=2
Mixed=3

Sample Request URL

https://api.cirrusplatform.com/api/v1/integrations/assessments?purposes=1,2

Sample successfull Response

[
  {
    "ExtId": "MB0-001",
    "Title": "Exam 1",
    "Purpose": 1,
    "AttemptDuration": 90,
    "AllowedNumberOfAttempts": 1
  },
  {
    "ExtId": "MB0-00123",
    "Title": "Exam 2",
    "Purpose": 2,
    "AttemptDuration": 90,
    "AllowedNumberOfAttempts": null
  }
]

Responses

Code Description
200 Successful operation