Skip to main content
GET
/
assessments
List assessments
curl --request GET \
  --url https://app.edpire.com/api/v1/assessments \
  --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"
    }
  ],
  "error": {
    "message": "<string>"
  },
  "meta": {
    "total": 123,
    "page": 123,
    "limit": 123
  }
}

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.

Query Parameters

status
enum<string>
Available options:
draft,
published,
archived
ids
string

Comma-separated UUIDs (max 50)

page
integer
default:1
Required range: x >= 1
limit
integer
default:20
Required range: 1 <= x <= 100

Response

Paginated list of assessments

data
object[]
error
object
meta
object