Skip to main content
GET
List quiz report participants

Authorizations

x-api-key
string
header
required

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

Path Parameters

quiz_id
string
required

The unique identifier of the quiz

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

"tYYueINbgmmyss8O3LiD"

Query Parameters

group_id
string

Filter participants by exact account group ID

Minimum string length: 1
Example:

"BgZupnpMujy4v1Zzd6sx"

track_id
string

Filter results to participants from a specific track (workflow). When specified, only participants who received the quiz via this track will be included.

Example:

"i3XJiIJjOp7PJJBTvu4i"

step_id
string

With track_id: only participants who received the quiz from this step of the track

Minimum string length: 1
Example:

"NKqbhqFnRyGChRhvM6bB"

variant_id
string

With track_id and step_id: only participants who got this variant of the step. Use default for the step's own content.

Minimum string length: 1
Example:

"default"

instance_id
string

Filter results to a specific instance. When specified, only participants from this scheduled activity will be included.

Minimum string length: 1
Example:

"abc123"

start_date
string<date-time>

Filter participants by assigned_at >= this exact ISO 8601 instant

Example:

"2026-01-01T00:00:00.000Z"

end_date
string<date-time>

Filter participants by assigned_at <= this exact ISO 8601 instant

Example:

"2026-01-31T23:59:59.999Z"

include_collaborators
boolean

Include quiz admin users in results (default false)

Example:

"false"

limit
integer
default:25

Maximum number of participants to return (1-10000, default 25)

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

25

starting_after
string

A participant id; returns the page after it

Maximum string length: 256
Example:

"06gPNJbvBuM2i8BKRXct:tYYueINbgmmyss8O3LiD"

ending_before
string

A participant id; returns the page before it

Maximum string length: 256
Example:

"pbxJ4YFZnz57I8ai343J:tYYueINbgmmyss8O3LiD"

status
enum<string>

Filter participants by status

Available options:
not_started,
in_progress,
completed,
expired
Example:

"completed"

statuses
enum<string>[]

Comma-separated participant statuses. Takes precedence over status.

Minimum array length: 1
Available options:
not_started,
in_progress,
completed,
expired
Example:

"completed,expired"

sort
enum<string>
default:name_asc

Participant order. Score ties use points, duration, name, member ID, then delivery ID.

Available options:
score_desc,
score_asc,
name_asc,
completed_at_desc,
completed_at_asc,
duration_asc
Example:

"score_desc"

min_score
number | null

Minimum participant score, inclusive

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

80

max_score
number | null

Maximum participant score, inclusive

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

100

Case-insensitive participant name or email search

Minimum string length: 1
Example:

"Amara"

include_question_responses
boolean

Include per-question responses for each participant (default false)

Example:

"true"

include_feedback
boolean

Include feedback responses from post-quiz surveys (default false)

Example:

"false"

Response

A page of participants

object
enum<string>
required
Available options:
list
data
object[]
required
has_more
boolean
required
url
string
required
Example:

"/v1/quizzes/tYYueINbgmmyss8O3LiD/report/participants"