Skip to main content
GET
Get quiz instance

Authorizations

x-api-key
string
header
required

API key for authentication. Generate keys in the Doozy dashboard.

Path Parameters

quizId
string
required

The ID of the quiz

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
Example:

"quiz_abc123"

instanceId
string
required

The ID of the instance

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
Example:

"sched_xyz789"

Response

Instance details

object
enum<string>
required

Object type identifier

Available options:
quiz_instance
Example:

"quiz_instance"

id
string
required

Unique instance identifier

Example:

"sched_xyz789"

quiz_id
string
required

The quiz this schedule is for

Example:

"quiz_abc123"

status
enum<string>
required

Current status of the schedule

Available options:
active,
paused,
cancelled,
completed
Example:

"active"

timezone
string
required

IANA timezone identifier

Example:

"America/New_York"

schedule
object | null
required

Recurring schedule (days + time), or null for full_quiz instances

recipients
object
required
schedule_at
string<date-time> | null
required

UTC datetime for one-off schedules (ISO 8601), or null for recurring schedules

Example:

"2026-06-15T09:00:00Z"

play_mode
enum<string>
required

Controls how quiz questions are delivered: one question per scheduled day, one round per day, or the entire quiz at once.

Available options:
one_question_per_day,
one_round_per_day,
full_quiz
Example:

"one_question_per_day"

speed
object
required

Speed bonus for this schedule (off by default).

lateness
object
required

Late-submission penalty for this schedule (off by default).

participant_standings
enum<string>
required

How people see standings. leaderboard: full ranked board for everyone. own_progress: each person sees their own rank (#3 of 24), not the board. hidden: results only — no rank, no board.

Available options:
leaderboard,
own_progress,
hidden
challenge_id
string | null
required

Challenge this schedule belongs to, or null.

Example:

"cmp_abc123"

expiry
object | null
required

Question expiry window, or null if no expiry

due
object | null
required

Answer due window, or null if no deadline

intro_message
string | null
required

Intro message sent with the first question

mandatory_completion
object | null
required

Mandatory completion settings, or null if completion is optional

feedback_survey
object | null
required

Post-quiz feedback survey config, or null if no feedback is collected

next_trigger_at
string | null
required

When the next question will be delivered (ISO 8601), or null if paused/cancelled

Example:

"2026-02-01T09:00:00.000Z"

created_at
string
required

When the schedule was created (ISO 8601)

Example:

"2026-01-15T10:30:00.000Z"

updated_at
string
required

When the schedule was last updated (ISO 8601)

Example:

"2026-01-20T14:00:00.000Z"

meta
object
required

What the requesting user can do with this quiz instance (edit, pause, resume, delete, activate, manage admins). Use these to drive UI affordances.