Skip to main content
GET
/
v1
/
surveys
/
{surveyId}
Get survey details
curl --request GET \
  --url https://api.doozy.live/v1/surveys/{surveyId} \
  --header 'x-api-key: <api-key>'
{
  "object": "survey",
  "id": "survey_abc123",
  "title": "Employee Satisfaction Survey",
  "description": "Monthly check-in on team satisfaction",
  "mode": "survey",
  "response_type": "anonymous",
  "results_visibility": "owner",
  "status": "scheduled",
  "question_count": 5,
  "track": {
    "id": "wf_abc123",
    "name": "Onboarding Program"
  },
  "instances": [
    {
      "object": "survey_instance",
      "id": "inst_xyz789",
      "scheduled_at": "2026-01-15T10:30:00.000Z",
      "end_at": "2026-01-22T10:30:00.000Z",
      "total_recipients": 50,
      "total_responses": 35,
      "response_rate": 70,
      "track_instance_id": "wf_inst_abc123"
    }
  ],
  "created_at": "2026-01-15T10:30:00.000Z",
  "updated_at": "2026-01-20T14:00:00.000Z",
  "questions": [
    {
      "object": "survey_question",
      "id": "q_abc123",
      "text": "How satisfied are you with your onboarding experience?",
      "type": "scale_1_to_10",
      "hint": "1 = Very dissatisfied, 10 = Very satisfied",
      "allow_comments": true,
      "choices": [
        "Option A",
        "Option B",
        "Option C"
      ],
      "allow_multiple": false
    }
  ]
}

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