Skip to main content
GET
Get survey instance

Authorizations

x-api-key
string
header
required

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

Path Parameters

survey_id
string
required

The ID of the survey

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

"2XOADZ5X978jbJUbveb9"

schedule_id
string
required

The ID of the schedule

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

"tdqYSbhl2En9Aue6iOr3"

Response

The survey instance

object
enum<string>
required

Object type identifier

Available options:
survey_schedule
Example:

"survey_schedule"

id
string
required

Unique schedule identifier

Example:

"tdqYSbhl2En9Aue6iOr3"

survey_id
string
required

The survey this schedule is for

Example:

"2XOADZ5X978jbJUbveb9"

status
enum<string>
required

Current status of the schedule

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

"active"

send_at
string<date-time> | null
required

UTC datetime (ISO 8601) for the next/scheduled send. For one-off, the chosen time. For recurring, the next firing — re-anchored from this when editing. Null when paused/canceled.

Example:

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

timezone
string
required

IANA timezone used to interpret send_at and to derive cadence day/time.

Example:

"America/New_York"

destination
object
required
include_future_members
boolean
required

Whether people who join the recipient cohort later also get this.

frequency
enum<string>
required

How often the survey is delivered

Available options:
once,
daily,
weekly,
biweekly,
monthly,
quarterly,
annually
Example:

"weekly"

intro_message
string | null
required

Intro message sent with the survey

mandatory_completion
object | null
required

Mandatory completion and reminder settings

next_trigger_at
string<date-time> | null
required

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

Example:

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

created_at
string<date-time>
required

When the schedule was created (ISO 8601)

Example:

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

updated_at
string<date-time>
required

When the schedule was last updated (ISO 8601)

Example:

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

source
enum<string>
required

Whether this schedule was created standalone or via a track

Available options:
standalone,
track
Example:

"standalone"

track
object | null
required

Track details if this schedule was created via a track

meta
object
required

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