AssignedQuiz
A request or response body; the type column links to the schemas it refers to.
AssignedQuiz
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | yes | — |
| slug | string | yes | — |
| name | string | yes | — |
| description | string | null | yes | — |
| footer_markdown | string | null | yes | Markdown the sitting renders beneath its last question, above the submit button; null shows nothing. |
| organization_id | string (uuid) | yes | — |
| organization_name | string | yes | — |
| delivery_kind | string | yes | live: takeable only while one of the quiz's scheduled sittings (scheduled_quizzes) is open — the same quiz can be scheduled year after year. async: self-scheduled, takeable whenever the quiz is published; sittings do not apply. one of "live" | "async" |
| time_limit_seconds | integer | null | yes | — |
| pass_percentage | number | yes | — |
| max_attempts | integer | null | yes | — |
| show_correct_answers | boolean | yes | — |
| current_sitting | ScheduledQuiz | yes | — |
| next_sitting | any | yes | — |
| state | string | yes | Takeability right now: async published quizzes are open; live ones are open inside a sitting, upcoming while one is yet to open, closed otherwise. one of "upcoming" | "open" | "closed" |
| attempts_used | integer | yes | Attempts counted against max_attempts: within the current sitting for live quizzes (0 when none is open), lifetime for async ones. |
| in_progress_attempt_id | string (uuid) | null | yes | — |
| latest_attempt | QuizAttempt | yes | — |
| has_passed | boolean | null | yes | Whether any attempt passed; null while no attempt has been submitted, results are withheld, or an attempt still awaits grading. |
{
"id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"slug": "string",
"name": "string",
"description": "string",
"footer_markdown": "string",
"organization_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"organization_name": "string",
"delivery_kind": "live",
"time_limit_seconds": 0,
"pass_percentage": 0,
"max_attempts": 0,
"show_correct_answers": true,
"current_sitting": {
"id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"quiz_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"label": "string",
"opens_at": "2026-01-01T00:00:00.000Z",
"closes_at": "2026-01-01T00:00:00.000Z",
"audience": "assignees",
"created_at": "2026-01-01T00:00:00.000Z"
},
"next_sitting": null,
"state": "upcoming",
"attempts_used": 0,
"in_progress_attempt_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"latest_attempt": {
"id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"quiz_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"scheduled_quiz_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"user_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
"user_display_name": "string",
"attempt_number": 0,
"status": "in_progress",
"started_at": "2026-01-01T00:00:00.000Z",
"deadline_at": "2026-01-01T00:00:00.000Z",
"submitted_at": "2026-01-01T00:00:00.000Z",
"auto_submitted": true,
"question_count": 0,
"correct_count": 0,
"points_possible": 0,
"points_awarded": 0,
"score_percentage": 0,
"passed": true,
"requires_manual_grading": true,
"finalized_at": "2026-01-01T00:00:00.000Z",
"results_released_at": "2026-01-01T00:00:00.000Z",
"results_visible": true
},
"has_passed": true
}