Skip to main content
GET
List quiz instances

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"

Query Parameters

limit
integer

Maximum number of results to return (1-100, default 25)

Required range: 1 <= x <= 100
Example:

25

starting_after
string

Cursor for pagination. Returns results after this instance ID.

Maximum string length: 256
Example:

"inst_xyz789"

scheduled_by_track
enum<string>

Filter by whether the instance was created by a track. When false, only standalone instances are returned. When true, only track-created instances are returned.

Available options:
true,
false
Example:

"false"

Response

List of quiz instances

object
enum<string>
required

Object type identifier

Available options:
list
Example:

"list"

data
object[]
required

Array of quiz schedule objects

has_more
boolean
required

Whether there are more results available

Example:

false

url
string
required

The URL for this list endpoint

Example:

"/v1/quizzes/quiz_abc123/instances"

next_cursor
string | null
required

Cursor for the next page of results

Example:

null

tracks
object[]

Tracks that deliver this quiz. Only included when scheduled_by_track is false.