Skip to main content
GET
Get survey details

Authorizations

x-api-key
string
header
required

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

Path Parameters

surveyId
string
required

The unique identifier of the survey

Minimum string length: 1
Example:

"survey_abc123"

Response

Survey details with questions and instances

object
enum<string>
required

Object type identifier

Available options:
survey
Example:

"survey"

id
string
required

Unique survey identifier

Example:

"survey_abc123"

title
string
required

Survey title

Example:

"Employee Satisfaction Survey"

description
string | null
required

Survey description

Example:

"Monthly check-in on team satisfaction"

mode
enum<string>
required

Survey mode (poll or survey)

Available options:
poll,
survey
Example:

"survey"

response_type
enum<string>
required

How responses are collected

Available options:
anonymous,
user
Example:

"anonymous"

results_visibility
enum<string>
required

Who can view results

Available options:
owner,
everyone
Example:

"owner"

status
enum<string>
required

Current survey status

Available options:
draft,
scheduled,
archived
Example:

"scheduled"

question_count
integer
required

Number of questions in the survey

Example:

5

track
object
required

Track reference if survey belongs to a track

instances
object[]
required

Delivery instances of this survey

created_at
string | null
required

When the survey was created (ISO 8601 format)

Example:

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

updated_at
string | null
required

When the survey was last updated (ISO 8601 format)

Example:

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

questions
object[]
required

Questions in the survey