API Overview

The Doozy API is currently in closed beta. To request access, please email hello@doozy.live.

The Doozy Public API provides access to your Doozy data, designed primarily for reporting and analytics use cases, as well as enrolling users on to tracks. Use it to extract quiz results, survey responses, and other engagement data into your preferred reporting tools.

Base URL

All API requests should be made to:

https://api.doozy.live

Available Endpoints

Quizzes

The Quiz API allows you to retrieve quiz data and detailed analytics reports:

Endpoint	Description
`GET /v1/quizzes`	List all quizzes you have access to
`GET /v1/quizzes/{quizId}`	Get detailed quiz information including rounds and questions
`GET /v1/quizzes/{quizId}/report`	Get comprehensive analytics and participant responses
`GET /v1/quizzes/{quizId}/instances`	List scheduled instances of a quiz
`GET /v1/quizzes/{quizId}/instances/{instanceId}`	Get a single quiz instance

Tracks

The Track API lets you read track definitions and progress, and enroll a user. Each step carries a day (an integer counted in weekdays from the member’s first day on the track, which is the day they are enrolled; 0 is that day, 5 is five weekdays later) and a time (a clock time like 09:00, or null for the 9am default). The track’s catch_up boolean describes what happens when someone enrolls after a step’s time has passed: true (the default) delivers the passed steps right away, in order; false shifts the whole track so Day 1 starts clean on the next working day. Nothing is ever skipped. On a legacy track authored before day-based timing, the response converts its stored timing to days and times and sets steps_converted to true; the stored track is unchanged until it is saved again. A message step’s post_as controls who a Slack-channel post appears to come from: {"type": "doozy"} (the default), {"type": "role", "role": "manager" | "cohortFacilitator"} resolved per run, or {"type": "member", "memberId": "..."} for a specific person. It’s ignored when the step delivers to a direct message or by email. For schedule triggers, frequency: "once" schedules one run at the configured start date and time. The read-only next_run_at field contains the next scheduled run time. It is null for draft or paused tracks and after Doozy finishes processing a one-off schedule. Updating other track fields does not schedule another run. To schedule another run, change the start date, time, or time zone.

Endpoint	Description
`GET /v1/tracks`	List all tracks you have access to
`GET /v1/tracks/{trackId}`	Get a track including its steps and their day and time
`GET /v1/tracks/{trackId}/report`	Get enrollment and completion analytics
`GET /v1/tracks/{trackId}/enrollees/{enrolleeId}`	Get one enrollee’s progress
`POST /v1/tracks/{trackId}/enroll`	Enroll a user in a track

Surveys

Endpoint	Description
`GET /v1/surveys`	List all surveys you have access to
`GET /v1/surveys/{surveyId}`	Get detailed survey information
`GET /v1/surveys/{surveyId}/report`	Get responses and analytics
`GET /v1/surveys/{surveyId}/trends`	Get response trends over time

Introductions

Endpoint	Description
`GET /v1/introductions`	List all introductions you have access to
`GET /v1/introductions/{introductionId}`	Get detailed introduction information
`GET /v1/introductions/{introductionId}/instances`	List instances of an introduction
`GET /v1/introductions/{introductionId}/report`	Get match and meeting analytics
`GET /v1/introductions/report`	Get aggregated analytics for introductions within a track

Pagination

The API uses cursor-based pagination for list endpoints. Use these query parameters:

Parameter	Description	Default	Maximum
`limit`	Number of items to return	25	100
`starting_after`	Cursor for pagination (ID of the last item from previous page)	-	-

Example

# First page
curl https://api.doozy.live/v1/quizzes?limit=25 \
  -H "x-api-key: dzy_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

# Next page (using the last quiz ID from the previous response)
curl https://api.doozy.live/v1/quizzes?limit=25&starting_after=quiz_abc123 \
  -H "x-api-key: dzy_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

OpenAPI Specification

Download the full OpenAPI specification for use with API clients, code generators, or other tooling:

Download OpenAPI Spec

OpenAPI 3.0 specification (JSON)

Next Steps

Authentication

Learn how to generate and manage API keys

Error Handling

Understand API error responses

Getting Started

Integrations

API reference

Base URL

Available Endpoints

Quizzes

Tracks

Surveys

Introductions

Example

OpenAPI Specification

Download OpenAPI Spec

Next Steps

Authentication

Error Handling

​Base URL

​Available Endpoints

​Quizzes

​Tracks

​Surveys

​Introductions

​Pagination

​Example

​OpenAPI Specification

Download OpenAPI Spec

​Next Steps

Authentication

Error Handling

Base URL

Available Endpoints

Quizzes

Tracks

Surveys

Introductions

Pagination

Example

OpenAPI Specification

Next Steps