Monotonic version number, incremented on each publish. 0 before the first publish — a never-published eager draft, which clients open directly in the editor rather than the detail page.
Active collaborative draft id. Clients connect their Yjs provider to /surveys/{id}/drafts/{current_draft_id} to participate in realtime editing. Null only for legacy surveys created before the collaborative editor rollout — those will lazy-mint a draft on first edit.
Profile of the last person to edit the current draft, or null.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Doozy Help","colors":{"primary":"#111","light":"#07C983","dark":"#111"},"logo":{"light":"https://mintcdn.com/doozy/YYQnSHcaAxwTvoP-/logo/light.svg?fit=max\u0026auto=format\u0026n=YYQnSHcaAxwTvoP-\u0026q=85\u0026s=7e15b956e576b83b95e9b26c2318e976","dark":"https://mintcdn.com/doozy/YYQnSHcaAxwTvoP-/logo/dark.svg?fit=max\u0026auto=format\u0026n=YYQnSHcaAxwTvoP-\u0026q=85\u0026s=69345da7d22f67d50b0b8b3ddf1f54ae"},"favicon":"https://mintcdn.com/doozy/SSKWtbcwl1NQIXNV/favicon.png?fit=max\u0026auto=format\u0026n=SSKWtbcwl1NQIXNV\u0026q=85\u0026s=75bc4ac30bc7fc8ce307d1932fcf4733","navbar":{"links":[{"href":"mailto:support@doozy.live","label":"Support"}],"primary":{"type":"button","label":"Try Doozy for free","href":"https://doozy.live/"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/doozyhq"}},"integrations":{"plausible":{"domain":"help.doozy.live"}},"styling":{"latex":false},"navigation":{"global":{"tabs":[{"tab":"Security \u0026 Privacy","href":"https://doozy.live/security"},{"tab":"Status","href":"https://status.doozy.live"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"doozy","hasAudioNarration":false,"actualSubdomain":"doozy","customDomains":["help.doozy.live"],"gitSource":{"type":"github","owner":"doozyhq","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adb44bf25769d6ebcdbd345","collectionId":"a6f2358e-6500-43e9-acb7-4e3fe41055e1","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adb44bf25769d6ebcdbd345"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6adb44bf25769d6ebcdbd345","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"Documentation","count":133},{"language":"default","tag":"🔌 Integrations","count":49},{"language":"default","tag":"HRIS Integrations","count":44},{"language":"default","tag":"Tracks","count":35},{"language":"default","tag":"API Reference","count":32},{"language":"default","tag":"API reference","count":26},{"language":"default","tag":"Build a track","count":20},{"language":"default","tag":"Steps","count":11},{"language":"default","tag":"⚙️ Admin","count":7},{"language":"default","tag":"🚀 Get Started","count":6}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/surveys/get-survey-details","slug":"/api-reference/surveys/get-survey-details","pageMetadata":{"title":"Get survey details","description":"Retrieve a specific survey by ID, including questions and delivery instances. Only accessible if the user is an admin of the survey.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/surveys/{surveyId}","href":"/api-reference/surveys/get-survey-details","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve a specific survey by ID, including questions and delivery instances. Only accessible if the user is an admin of the survey.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get survey details","description":"Retrieve a specific survey by ID, including questions and delivery instances. Only accessible if the user is an admin of the survey.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/surveys/{surveyId}","href":"/api-reference/surveys/get-survey-details","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/doozy/a99f027560001d9c/extract-metadata.js"],"openApiReferenceData":{"operation":{"summary":"Get survey details","description":"Retrieve a specific survey by ID, including questions and delivery instances. Only accessible if the user is an admin of the survey.","tags":["Surveys"],"security":["b1bc6897-5bd8-4091-a725-65a3e1849e26"],"parameters":["fdfc1c7e-3992-4147-84f0-f17346066f6a"],"responses":{"200":"6da74ce1-7d93-47b0-946d-f53c25805ce3","401":"ae864db9-4077-4646-b14e-277a2228b50f","403":"cb81cd90-5f39-4d7f-b28f-551a208e66c7","404":"f20c8f26-90e2-42e4-b62f-cd9ec350d2e2"},"method":"get","type":"path","servers":["5b6ba15e-bfcd-4066-979f-bcc84b7fa805"],"path":"/v1/surveys/{surveyId}","baseUrlOptions":["https://api.doozy.live"],"title":"Get survey details","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"fdfc1c7e-3992-4147-84f0-f17346066f6a":{"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[A-Za-z0-9_-]+$","description":"The unique identifier of the survey","example":"survey_abc123","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"description":"The unique identifier of the survey","name":"surveyId","in":"path"}},"responses":{"6da74ce1-7d93-47b0-946d-f53c25805ce3":{"description":"Survey details with questions and instances","content":{"application/json":{"schema":{"type":"object","required":["result_visibility","questions","admin_users","current_draft_id","last_published_at","last_published_by","draft_has_unpublished_changes","draft_last_edited_at","draft_last_edited_by","object","id","title","description","mode","response_type","results_visibility","status","published_version","question_count","time_limit_minutes","track","instances","created_at","updated_at","meta"],"properties":{"object":{"type":"string","enum":["survey"],"description":"Object type identifier","example":"survey","isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"Unique survey identifier","example":"survey_abc123","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"title":{"type":"string","description":"Survey title","example":"Employee Satisfaction Survey","isRequired":true,"uniqueKey":"title","typeLabel":"string"},"description":{"oneOf":[{"type":"string","description":"Survey description","example":"Monthly check-in on team satisfaction","isRequired":true,"uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","description":"Survey description","example":"Monthly check-in on team satisfaction","isRequired":true,"uniqueKey":"description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"description","typeLabel":"string | null"},"mode":{"type":"string","description":"Survey mode (poll or survey)","enum":["poll","survey"],"example":"survey","isRequired":true,"uniqueKey":"mode","typeLabel":"enum\u003cstring>"},"response_type":{"type":"string","description":"How responses are collected","enum":["anonymous","user"],"example":"anonymous","isRequired":true,"uniqueKey":"response_type","typeLabel":"enum\u003cstring>"},"results_visibility":{"type":"string","description":"Who can view results","enum":["owner","everyone"],"example":"owner","isRequired":true,"uniqueKey":"results_visibility","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"Current survey status","enum":["draft","scheduled","archived"],"example":"scheduled","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"published_version":{"type":"integer","minimum":0,"description":"Monotonic version number, incremented on each publish. 0 before the first publish — a never-published eager draft, which clients open directly in the editor rather than the detail page.","example":3,"isRequired":true,"uniqueKey":"published_version","typeLabel":"integer"},"question_count":{"type":"integer","description":"Number of questions in the survey","example":5,"isRequired":true,"uniqueKey":"question_count","typeLabel":"integer"},"time_limit_minutes":{"oneOf":[{"type":"integer","minimum":1,"description":"Time limit in minutes for completing the survey (null for no limit)","example":30,"isRequired":true,"uniqueKey":"time_limit_minutes.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"description":"Time limit in minutes for completing the survey (null for no limit)","example":30,"isRequired":true,"uniqueKey":"time_limit_minutes.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"time_limit_minutes","typeLabel":"integer | null"},"track":{"type":"object","description":"Track reference if survey belongs to a track","required":["id","name"],"properties":{"id":{"type":"string","description":"Track ID","example":"wf_abc123","isRequired":true,"uniqueKey":"track.id","typeLabel":"string"},"name":{"type":"string","description":"Track name","example":"Onboarding Program","isRequired":true,"uniqueKey":"track.name","typeLabel":"string"}},"isRequired":true,"uniqueKey":"track","typeLabel":"object"},"instances":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","enum":["survey_instance"],"description":"Object type identifier","example":"survey_instance","isRequired":true,"uniqueKey":"instances.items.[INDEX].object","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"Unique instance identifier","example":"inst_xyz789","isRequired":true,"uniqueKey":"instances.items.[INDEX].id","typeLabel":"string"},"scheduled_at":{"oneOf":[{"type":"string","description":"When the survey was sent (ISO 8601 format)","example":"2026-01-15T10:30:00.000Z","isRequired":true,"uniqueKey":"instances.items.[INDEX].scheduled_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the survey was sent (ISO 8601 format)","example":"2026-01-15T10:30:00.000Z","isRequired":true,"uniqueKey":"instances.items.[INDEX].scheduled_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"instances.items.[INDEX].scheduled_at","typeLabel":"string | null"},"end_at":{"oneOf":[{"type":"string","description":"When the survey closes for responses (ISO 8601 format)","example":"2026-01-22T10:30:00.000Z","isRequired":true,"uniqueKey":"instances.items.[INDEX].end_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the survey closes for responses (ISO 8601 format)","example":"2026-01-22T10:30:00.000Z","isRequired":true,"uniqueKey":"instances.items.[INDEX].end_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"instances.items.[INDEX].end_at","typeLabel":"string | null"},"total_recipients":{"type":"integer","description":"Number of users who received this instance","example":50,"isRequired":true,"uniqueKey":"instances.items.[INDEX].total_recipients","typeLabel":"integer"},"total_responses":{"type":"integer","description":"Number of responses received","example":35,"isRequired":true,"uniqueKey":"instances.items.[INDEX].total_responses","typeLabel":"integer"},"response_rate":{"type":"number","description":"Percentage of recipients who responded (0-100)","example":70,"isRequired":true,"uniqueKey":"instances.items.[INDEX].response_rate","typeLabel":"number"},"track_id":{"oneOf":[{"type":"string","description":"Track (workflow) ID if part of a track delivery","example":"wf_abc123","isRequired":true,"uniqueKey":"instances.items.[INDEX].track_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Track (workflow) ID if part of a track delivery","example":"wf_abc123","isRequired":true,"uniqueKey":"instances.items.[INDEX].track_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"instances.items.[INDEX].track_id","typeLabel":"string | null"},"track_name":{"oneOf":[{"type":"string","description":"Track (workflow) name if part of a track delivery","example":"Onboarding Track","isRequired":true,"uniqueKey":"instances.items.[INDEX].track_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Track (workflow) name if part of a track delivery","example":"Onboarding Track","isRequired":true,"uniqueKey":"instances.items.[INDEX].track_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"instances.items.[INDEX].track_name","typeLabel":"string | null"},"track_instance_id":{"oneOf":[{"type":"string","description":"Track instance ID if part of a track delivery","example":"wf_inst_abc123","isRequired":true,"uniqueKey":"instances.items.[INDEX].track_instance_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Track instance ID if part of a track delivery","example":"wf_inst_abc123","isRequired":true,"uniqueKey":"instances.items.[INDEX].track_instance_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"instances.items.[INDEX].track_instance_id","typeLabel":"string | null"},"schedule_id":{"oneOf":[{"type":"string","description":"Schedule ID that created this instance","example":"sched_abc123","isRequired":true,"uniqueKey":"instances.items.[INDEX].schedule_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Schedule ID that created this instance","example":"sched_abc123","isRequired":true,"uniqueKey":"instances.items.[INDEX].schedule_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"instances.items.[INDEX].schedule_id","typeLabel":"string | null"},"introduction_feedback":{"oneOf":[{"type":"object","properties":{"introduction_id":{"type":"string","isRequired":true,"uniqueKey":"instances.items.[INDEX].introduction_feedback.oneOf.0.introduction_id","typeLabel":"string"},"run_id":{"type":"string","isRequired":true,"uniqueKey":"instances.items.[INDEX].introduction_feedback.oneOf.0.run_id","typeLabel":"string"},"match_id":{"type":"string","isRequired":true,"uniqueKey":"instances.items.[INDEX].introduction_feedback.oneOf.0.match_id","typeLabel":"string"},"participants":{"type":"array","items":{"type":"object","properties":{"doozy_user_id":{"type":"string","isRequired":true,"uniqueKey":"instances.items.[INDEX].introduction_feedback.oneOf.0.participants.items.[INDEX].doozy_user_id","typeLabel":"string"},"slack_user_id":{"type":"string","isRequired":true,"uniqueKey":"instances.items.[INDEX].introduction_feedback.oneOf.0.participants.items.[INDEX].slack_user_id","typeLabel":"string"},"display_name":{"type":"string","isRequired":true,"uniqueKey":"instances.items.[INDEX].introduction_feedback.oneOf.0.participants.items.[INDEX].display_name","typeLabel":"string"}},"required":["doozy_user_id","slack_user_id","display_name"],"uniqueKey":"instances.items.[INDEX].introduction_feedback.oneOf.0.participants.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"instances.items.[INDEX].introduction_feedback.oneOf.0.participants","typeLabel":"object[]"}},"required":["introduction_id","run_id","match_id","participants"],"description":"Match context identifying who the introduction feedback concerns.","isRequired":true,"uniqueKey":"instances.items.[INDEX].introduction_feedback.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"introduction_id":{"type":"string"},"run_id":{"type":"string"},"match_id":{"type":"string"},"participants":{"type":"array","items":{"type":"object","properties":{"doozy_user_id":{"type":"string"},"slack_user_id":{"type":"string"},"display_name":{"type":"string"}},"required":["doozy_user_id","slack_user_id","display_name"]}}},"required":["introduction_id","run_id","match_id","participants"],"description":"Match context identifying who the introduction feedback concerns.","isRequired":true,"uniqueKey":"instances.items.[INDEX].introduction_feedback.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"instances.items.[INDEX].introduction_feedback","typeLabel":"object | null"}},"required":["object","id","scheduled_at","end_at","total_recipients","total_responses","response_rate","track_id","track_name","track_instance_id","schedule_id","introduction_feedback"],"uniqueKey":"instances.items.[INDEX]","typeLabel":"object"},"description":"Delivery instances of this survey","isRequired":true,"uniqueKey":"instances","typeLabel":"object[]"},"created_at":{"oneOf":[{"type":"string","description":"When the survey was created (ISO 8601 format)","example":"2026-01-15T10:30:00.000Z","isRequired":true,"uniqueKey":"created_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the survey was created (ISO 8601 format)","example":"2026-01-15T10:30:00.000Z","isRequired":true,"uniqueKey":"created_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"created_at","typeLabel":"string | null"},"updated_at":{"oneOf":[{"type":"string","description":"When the survey was last updated (ISO 8601 format)","example":"2026-01-20T14:00:00.000Z","isRequired":true,"uniqueKey":"updated_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"When the survey was last updated (ISO 8601 format)","example":"2026-01-20T14:00:00.000Z","isRequired":true,"uniqueKey":"updated_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"updated_at","typeLabel":"string | null"},"meta":{"type":"object","description":"What the requesting user can do with this survey (edit, pause, resume, delete, activate, manage admins). Use these to drive UI affordances.","required":["permissions"],"properties":{"permissions":{"type":"object","properties":{"can_view_results":{"type":"boolean","isRequired":true,"uniqueKey":"meta.permissions.can_view_results","typeLabel":"boolean"},"can_clone":{"type":"boolean","isRequired":true,"uniqueKey":"meta.permissions.can_clone","typeLabel":"boolean"},"can_manage":{"type":"boolean","isRequired":true,"uniqueKey":"meta.permissions.can_manage","typeLabel":"boolean"},"can_edit":{"type":"boolean","isRequired":true,"uniqueKey":"meta.permissions.can_edit","typeLabel":"boolean"},"can_pause":{"type":"boolean","isRequired":true,"uniqueKey":"meta.permissions.can_pause","typeLabel":"boolean"},"can_resume":{"type":"boolean","isRequired":true,"uniqueKey":"meta.permissions.can_resume","typeLabel":"boolean"},"can_delete":{"type":"boolean","isRequired":true,"uniqueKey":"meta.permissions.can_delete","typeLabel":"boolean"},"can_activate":{"type":"boolean","isRequired":true,"uniqueKey":"meta.permissions.can_activate","typeLabel":"boolean"},"can_manage_admins":{"type":"boolean","isRequired":true,"uniqueKey":"meta.permissions.can_manage_admins","typeLabel":"boolean"}},"required":["can_view_results","can_clone","can_manage","can_edit","can_pause","can_resume","can_delete","can_activate","can_manage_admins"],"isRequired":true,"uniqueKey":"meta.permissions","typeLabel":"object"}},"isRequired":true,"uniqueKey":"meta","typeLabel":"object"},"result_visibility":{"oneOf":[{"type":"object","description":"Who, beyond the survey's admins, can see an individual's responses in the People view. Null means owner only. Distinct from results_visibility.","required":["managers_can_view"],"properties":{"managers_can_view":{"type":"boolean","description":"When true, a member's manager-of-record can see that member's results for this activity in the People view.","isRequired":true,"uniqueKey":"result_visibility.oneOf.0.managers_can_view","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"result_visibility.oneOf.0","typeLabel":"object"},{"type":"null","description":"Who, beyond the survey's admins, can see an individual's responses in the People view. Null means owner only. Distinct from results_visibility.","required":["managers_can_view"],"properties":{"managers_can_view":{"type":"boolean","description":"When true, a member's manager-of-record can see that member's results for this activity in the People view."}},"isRequired":true,"uniqueKey":"result_visibility.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"result_visibility","typeLabel":"object | null"},"questions":{"type":"array","items":{"type":"object","properties":{"object":{"type":"string","enum":["survey_question"],"description":"Object type identifier","example":"survey_question","isRequired":true,"uniqueKey":"questions.items.[INDEX].object","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"Unique question identifier","example":"q_abc123","isRequired":true,"uniqueKey":"questions.items.[INDEX].id","typeLabel":"string"},"text":{"type":"string","description":"The question text","example":"How satisfied are you with your onboarding experience?","isRequired":true,"uniqueKey":"questions.items.[INDEX].text","typeLabel":"string"},"type":{"type":"string","description":"Type of question","enum":["scale_1_to_10","scale_1_to_5","emoji_1_to_5","agree_disagree","enps","open_ended","multiple_choice"],"example":"scale_1_to_10","isRequired":true,"uniqueKey":"questions.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"hint":{"oneOf":[{"type":"string","description":"Optional hint text for the question","example":"1 = Very dissatisfied, 10 = Very satisfied","isRequired":true,"uniqueKey":"questions.items.[INDEX].hint.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional hint text for the question","example":"1 = Very dissatisfied, 10 = Very satisfied","isRequired":true,"uniqueKey":"questions.items.[INDEX].hint.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"questions.items.[INDEX].hint","typeLabel":"string | null"},"allow_comments":{"type":"boolean","description":"Whether respondents can add comments to their answer","example":true,"isRequired":true,"uniqueKey":"questions.items.[INDEX].allow_comments","typeLabel":"boolean"},"required":{"type":"boolean","description":"Whether respondents must answer this question. Optional questions can be skipped.","example":true,"isRequired":true,"uniqueKey":"questions.items.[INDEX].required","typeLabel":"boolean"},"choices":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"questions.items.[INDEX].choices.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Available choices for multiple choice questions","example":["Option A","Option B","Option C"],"isRequired":true,"uniqueKey":"questions.items.[INDEX].choices.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Available choices for multiple choice questions","example":["Option A","Option B","Option C"],"isRequired":true,"uniqueKey":"questions.items.[INDEX].choices.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"questions.items.[INDEX].choices","typeLabel":"string[] | null"},"allow_multiple":{"oneOf":[{"type":"boolean","description":"Whether multiple choices can be selected (multiple choice only)","example":false,"isRequired":true,"uniqueKey":"questions.items.[INDEX].allow_multiple.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether multiple choices can be selected (multiple choice only)","example":false,"isRequired":true,"uniqueKey":"questions.items.[INDEX].allow_multiple.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"questions.items.[INDEX].allow_multiple","typeLabel":"boolean | null"}},"required":["object","id","text","type","hint","allow_comments","required","choices","allow_multiple"],"uniqueKey":"questions.items.[INDEX]","typeLabel":"object"},"description":"Questions in the survey","isRequired":true,"uniqueKey":"questions","typeLabel":"object[]"},"admin_users":{"type":"array","items":{"type":"string","uniqueKey":"admin_users.items.[INDEX]","typeLabel":"string"},"description":"Doozy user IDs of members who can edit this survey and view its results.","example":["user_abc123","user_def456"],"isRequired":true,"uniqueKey":"admin_users","typeLabel":"string[]"},"current_draft_id":{"oneOf":[{"type":"string","description":"Active collaborative draft id. Clients connect their Yjs provider to /surveys/{id}/drafts/{current_draft_id} to participate in realtime editing. Null only for legacy surveys created before the collaborative editor rollout — those will lazy-mint a draft on first edit.","example":"draft_abc123","isRequired":true,"uniqueKey":"current_draft_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Active collaborative draft id. Clients connect their Yjs provider to /surveys/{id}/drafts/{current_draft_id} to participate in realtime editing. Null only for legacy surveys created before the collaborative editor rollout — those will lazy-mint a draft on first edit.","example":"draft_abc123","isRequired":true,"uniqueKey":"current_draft_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"current_draft_id","typeLabel":"string | null"},"last_published_at":{"oneOf":[{"type":"string","description":"ISO 8601 timestamp of the most recent publish, or null if never published.","example":"2026-06-10T09:48:36.000Z","isRequired":true,"uniqueKey":"last_published_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 8601 timestamp of the most recent publish, or null if never published.","example":"2026-06-10T09:48:36.000Z","isRequired":true,"uniqueKey":"last_published_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"last_published_at","typeLabel":"string | null"},"last_published_by":{"oneOf":[{"type":"object","properties":{"user_id":{"type":"string","description":"Doozy user ID","example":"user_abc123","isRequired":true,"uniqueKey":"last_published_by.oneOf.0.user_id","typeLabel":"string"},"display_name":{"type":"string","description":"Member's display name","example":"John Doe","isRequired":true,"uniqueKey":"last_published_by.oneOf.0.display_name","typeLabel":"string"},"email":{"type":"string","description":"Member's email address","example":"john@example.com","isRequired":true,"uniqueKey":"last_published_by.oneOf.0.email","typeLabel":"string"},"slack_user_id":{"oneOf":[{"type":"string","description":"Member's Slack user ID","example":"U1234567890","isRequired":true,"uniqueKey":"last_published_by.oneOf.0.slack_user_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Member's Slack user ID","example":"U1234567890","isRequired":true,"uniqueKey":"last_published_by.oneOf.0.slack_user_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"last_published_by.oneOf.0.slack_user_id","typeLabel":"string | null"},"image_token":{"oneOf":[{"type":"string","description":"Legacy profile image token (resolves to a signed avatar URL)","example":"img_abc123","isRequired":true,"uniqueKey":"last_published_by.oneOf.0.image_token.oneOf.0","typeLabel":"string"},{"type":"null","description":"Legacy profile image token (resolves to a signed avatar URL)","example":"img_abc123","isRequired":true,"uniqueKey":"last_published_by.oneOf.0.image_token.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"last_published_by.oneOf.0.image_token","typeLabel":"string | null"},"image_url":{"oneOf":[{"type":"object","properties":{"image_24":{"type":"string","uniqueKey":"last_published_by.oneOf.0.image_url.oneOf.0.image_24","typeLabel":"string"},"image_32":{"type":"string","uniqueKey":"last_published_by.oneOf.0.image_url.oneOf.0.image_32","typeLabel":"string"},"image_48":{"type":"string","uniqueKey":"last_published_by.oneOf.0.image_url.oneOf.0.image_48","typeLabel":"string"},"image_72":{"type":"string","uniqueKey":"last_published_by.oneOf.0.image_url.oneOf.0.image_72","typeLabel":"string"},"image_192":{"type":"string","uniqueKey":"last_published_by.oneOf.0.image_url.oneOf.0.image_192","typeLabel":"string"},"image_512":{"type":"string","uniqueKey":"last_published_by.oneOf.0.image_url.oneOf.0.image_512","typeLabel":"string"},"image_1024":{"type":"string","uniqueKey":"last_published_by.oneOf.0.image_url.oneOf.0.image_1024","typeLabel":"string"},"image_original":{"type":"string","uniqueKey":"last_published_by.oneOf.0.image_url.oneOf.0.image_original","typeLabel":"string"}},"description":"Slack-sourced profile image URLs by size (preferred avatar)","isRequired":true,"uniqueKey":"last_published_by.oneOf.0.image_url.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"image_24":{"type":"string"},"image_32":{"type":"string"},"image_48":{"type":"string"},"image_72":{"type":"string"},"image_192":{"type":"string"},"image_512":{"type":"string"},"image_1024":{"type":"string"},"image_original":{"type":"string"}},"description":"Slack-sourced profile image URLs by size (preferred avatar)","isRequired":true,"uniqueKey":"last_published_by.oneOf.0.image_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"last_published_by.oneOf.0.image_url","typeLabel":"object | null"}},"required":["user_id","display_name","email","slack_user_id","image_token","image_url"],"description":"Profile of the person who last published, or null.","isRequired":true,"uniqueKey":"last_published_by.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"user_id":{"type":"string","description":"Doozy user ID","example":"user_abc123"},"display_name":{"type":"string","description":"Member's display name","example":"John Doe"},"email":{"type":"string","description":"Member's email address","example":"john@example.com"},"slack_user_id":{"oneOf":[{"type":"string","description":"Member's Slack user ID","example":"U1234567890"},{"type":"null","description":"Member's Slack user ID","example":"U1234567890"}]},"image_token":{"oneOf":[{"type":"string","description":"Legacy profile image token (resolves to a signed avatar URL)","example":"img_abc123"},{"type":"null","description":"Legacy profile image token (resolves to a signed avatar URL)","example":"img_abc123"}]},"image_url":{"oneOf":[{"type":"object","properties":{"image_24":{"type":"string"},"image_32":{"type":"string"},"image_48":{"type":"string"},"image_72":{"type":"string"},"image_192":{"type":"string"},"image_512":{"type":"string"},"image_1024":{"type":"string"},"image_original":{"type":"string"}},"description":"Slack-sourced profile image URLs by size (preferred avatar)"},{"type":"null","properties":{"image_24":{"type":"string"},"image_32":{"type":"string"},"image_48":{"type":"string"},"image_72":{"type":"string"},"image_192":{"type":"string"},"image_512":{"type":"string"},"image_1024":{"type":"string"},"image_original":{"type":"string"}},"description":"Slack-sourced profile image URLs by size (preferred avatar)"}]}},"required":["user_id","display_name","email","slack_user_id","image_token","image_url"],"description":"Profile of the person who last published, or null.","isRequired":true,"uniqueKey":"last_published_by.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"last_published_by","typeLabel":"object | null"},"draft_has_unpublished_changes":{"type":"boolean","description":"True when the current draft has edits that diverge from the published survey.","example":true,"isRequired":true,"uniqueKey":"draft_has_unpublished_changes","typeLabel":"boolean"},"draft_last_edited_at":{"oneOf":[{"type":"string","description":"ISO 8601 timestamp of the last edit to the current draft, or null.","example":"2026-06-10T10:15:00.000Z","isRequired":true,"uniqueKey":"draft_last_edited_at.oneOf.0","typeLabel":"string"},{"type":"null","description":"ISO 8601 timestamp of the last edit to the current draft, or null.","example":"2026-06-10T10:15:00.000Z","isRequired":true,"uniqueKey":"draft_last_edited_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"draft_last_edited_at","typeLabel":"string | null"},"draft_last_edited_by":{"oneOf":[{"type":"object","description":"Profile of the last person to edit the current draft, or null.","required":["user_id","display_name","email","slack_user_id","image_token","image_url"],"properties":{"user_id":{"type":"string","description":"Doozy user ID","example":"user_abc123","isRequired":true,"uniqueKey":"draft_last_edited_by.oneOf.0.user_id","typeLabel":"string"},"display_name":{"type":"string","description":"Member's display name","example":"John Doe","isRequired":true,"uniqueKey":"draft_last_edited_by.oneOf.0.display_name","typeLabel":"string"},"email":{"type":"string","description":"Member's email address","example":"john@example.com","isRequired":true,"uniqueKey":"draft_last_edited_by.oneOf.0.email","typeLabel":"string"},"slack_user_id":{"oneOf":[{"type":"string","description":"Member's Slack user ID","example":"U1234567890","isRequired":true,"uniqueKey":"draft_last_edited_by.oneOf.0.slack_user_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Member's Slack user ID","example":"U1234567890","isRequired":true,"uniqueKey":"draft_last_edited_by.oneOf.0.slack_user_id.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"draft_last_edited_by.oneOf.0.slack_user_id","typeLabel":"string | null"},"image_token":{"oneOf":[{"type":"string","description":"Legacy profile image token (resolves to a signed avatar URL)","example":"img_abc123","isRequired":true,"uniqueKey":"draft_last_edited_by.oneOf.0.image_token.oneOf.0","typeLabel":"string"},{"type":"null","description":"Legacy profile image token (resolves to a signed avatar URL)","example":"img_abc123","isRequired":true,"uniqueKey":"draft_last_edited_by.oneOf.0.image_token.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"draft_last_edited_by.oneOf.0.image_token","typeLabel":"string | null"},"image_url":{"oneOf":[{"type":"object","properties":{"image_24":{"type":"string","uniqueKey":"draft_last_edited_by.oneOf.0.image_url.oneOf.0.image_24","typeLabel":"string"},"image_32":{"type":"string","uniqueKey":"draft_last_edited_by.oneOf.0.image_url.oneOf.0.image_32","typeLabel":"string"},"image_48":{"type":"string","uniqueKey":"draft_last_edited_by.oneOf.0.image_url.oneOf.0.image_48","typeLabel":"string"},"image_72":{"type":"string","uniqueKey":"draft_last_edited_by.oneOf.0.image_url.oneOf.0.image_72","typeLabel":"string"},"image_192":{"type":"string","uniqueKey":"draft_last_edited_by.oneOf.0.image_url.oneOf.0.image_192","typeLabel":"string"},"image_512":{"type":"string","uniqueKey":"draft_last_edited_by.oneOf.0.image_url.oneOf.0.image_512","typeLabel":"string"},"image_1024":{"type":"string","uniqueKey":"draft_last_edited_by.oneOf.0.image_url.oneOf.0.image_1024","typeLabel":"string"},"image_original":{"type":"string","uniqueKey":"draft_last_edited_by.oneOf.0.image_url.oneOf.0.image_original","typeLabel":"string"}},"description":"Slack-sourced profile image URLs by size (preferred avatar)","isRequired":true,"uniqueKey":"draft_last_edited_by.oneOf.0.image_url.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"image_24":{"type":"string"},"image_32":{"type":"string"},"image_48":{"type":"string"},"image_72":{"type":"string"},"image_192":{"type":"string"},"image_512":{"type":"string"},"image_1024":{"type":"string"},"image_original":{"type":"string"}},"description":"Slack-sourced profile image URLs by size (preferred avatar)","isRequired":true,"uniqueKey":"draft_last_edited_by.oneOf.0.image_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"draft_last_edited_by.oneOf.0.image_url","typeLabel":"object | null"}},"isRequired":true,"uniqueKey":"draft_last_edited_by.oneOf.0","typeLabel":"object"},{"type":"null","description":"Profile of the last person to edit the current draft, or null.","required":["user_id","display_name","email","slack_user_id","image_token","image_url"],"properties":{"user_id":{"type":"string","description":"Doozy user ID","example":"user_abc123"},"display_name":{"type":"string","description":"Member's display name","example":"John Doe"},"email":{"type":"string","description":"Member's email address","example":"john@example.com"},"slack_user_id":{"oneOf":[{"type":"string","description":"Member's Slack user ID","example":"U1234567890"},{"type":"null","description":"Member's Slack user ID","example":"U1234567890"}]},"image_token":{"oneOf":[{"type":"string","description":"Legacy profile image token (resolves to a signed avatar URL)","example":"img_abc123"},{"type":"null","description":"Legacy profile image token (resolves to a signed avatar URL)","example":"img_abc123"}]},"image_url":{"oneOf":[{"type":"object","properties":{"image_24":{"type":"string"},"image_32":{"type":"string"},"image_48":{"type":"string"},"image_72":{"type":"string"},"image_192":{"type":"string"},"image_512":{"type":"string"},"image_1024":{"type":"string"},"image_original":{"type":"string"}},"description":"Slack-sourced profile image URLs by size (preferred avatar)"},{"type":"null","properties":{"image_24":{"type":"string"},"image_32":{"type":"string"},"image_48":{"type":"string"},"image_72":{"type":"string"},"image_192":{"type":"string"},"image_512":{"type":"string"},"image_1024":{"type":"string"},"image_original":{"type":"string"}},"description":"Slack-sourced profile image URLs by size (preferred avatar)"}]}},"isRequired":true,"uniqueKey":"draft_last_edited_by.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"draft_last_edited_by","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"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","published_version":3,"question_count":5,"time_limit_minutes":30,"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_id":"wf_abc123","track_name":"Onboarding Track","track_instance_id":"wf_inst_abc123","schedule_id":"sched_abc123","introduction_feedback":{"introduction_id":"\u003cstring>","run_id":"\u003cstring>","match_id":"\u003cstring>","participants":[{"doozy_user_id":"\u003cstring>","slack_user_id":"\u003cstring>","display_name":"\u003cstring>"}]}}],"created_at":"2026-01-15T10:30:00.000Z","updated_at":"2026-01-20T14:00:00.000Z","meta":{"permissions":{"can_view_results":true,"can_clone":true,"can_manage":true,"can_edit":true,"can_pause":true,"can_resume":true,"can_delete":true,"can_activate":true,"can_manage_admins":true}},"result_visibility":{"managers_can_view":true},"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,"required":true,"choices":["Option A","Option B","Option C"],"allow_multiple":false}],"admin_users":["user_abc123","user_def456"],"current_draft_id":"draft_abc123","last_published_at":"2026-06-10T09:48:36.000Z","last_published_by":{"user_id":"user_abc123","display_name":"John Doe","email":"john@example.com","slack_user_id":"U1234567890","image_token":"img_abc123","image_url":{"image_24":"\u003cstring>","image_32":"\u003cstring>","image_48":"\u003cstring>","image_72":"\u003cstring>","image_192":"\u003cstring>","image_512":"\u003cstring>","image_1024":"\u003cstring>","image_original":"\u003cstring>"}},"draft_has_unpublished_changes":true,"draft_last_edited_at":"2026-06-10T10:15:00.000Z","draft_last_edited_by":{"user_id":"user_abc123","display_name":"John Doe","email":"john@example.com","slack_user_id":"U1234567890","image_token":"img_abc123","image_url":{"image_24":"\u003cstring>","image_32":"\u003cstring>","image_48":"\u003cstring>","image_72":"\u003cstring>","image_192":"\u003cstring>","image_512":"\u003cstring>","image_1024":"\u003cstring>","image_original":"\u003cstring>"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"ae864db9-4077-4646-b14e-277a2228b50f":{"description":"Authentication required - missing API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["api_error","authentication_error","invalid_request_error","rate_limit_error"],"description":"The type of error returned","example":"invalid_request_error","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"oneOf":[{"type":"string","description":"Machine-readable error code for specific error conditions","example":"resource_not_found","isRequired":true,"uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Machine-readable error code for specific error conditions","example":"resource_not_found","isRequired":true,"uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.code","typeLabel":"string | null"},"message":{"type":"string","description":"Human-readable error message","example":"No such quiz: quiz_abc123","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"The parameter related to the error, if applicable","example":"id","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The parameter related to the error, if applicable","example":"id","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"doc_url":{"type":"string","format":"uri","description":"URL to documentation about this error","example":"https://docs.doozy.live/api/errors#resource_not_found","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"}},"required":["type","code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"resource_not_found","message":"No such quiz: quiz_abc123","param":"id","doc_url":"https://docs.doozy.live/api/errors#resource_not_found"}}}},"exampleType":"generated"}},"exampleType":"generated"},"cb81cd90-5f39-4d7f-b28f-551a208e66c7":{"description":"Invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["api_error","authentication_error","invalid_request_error","rate_limit_error"],"description":"The type of error returned","example":"invalid_request_error","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"oneOf":[{"type":"string","description":"Machine-readable error code for specific error conditions","example":"resource_not_found","isRequired":true,"uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Machine-readable error code for specific error conditions","example":"resource_not_found","isRequired":true,"uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.code","typeLabel":"string | null"},"message":{"type":"string","description":"Human-readable error message","example":"No such quiz: quiz_abc123","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"The parameter related to the error, if applicable","example":"id","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The parameter related to the error, if applicable","example":"id","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"doc_url":{"type":"string","format":"uri","description":"URL to documentation about this error","example":"https://docs.doozy.live/api/errors#resource_not_found","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"}},"required":["type","code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"resource_not_found","message":"No such quiz: quiz_abc123","param":"id","doc_url":"https://docs.doozy.live/api/errors#resource_not_found"}}}},"exampleType":"generated"}},"exampleType":"generated"},"f20c8f26-90e2-42e4-b62f-cd9ec350d2e2":{"description":"Survey not found or user does not have access","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","enum":["api_error","authentication_error","invalid_request_error","rate_limit_error"],"description":"The type of error returned","example":"invalid_request_error","isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"code":{"oneOf":[{"type":"string","description":"Machine-readable error code for specific error conditions","example":"resource_not_found","isRequired":true,"uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"Machine-readable error code for specific error conditions","example":"resource_not_found","isRequired":true,"uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.code","typeLabel":"string | null"},"message":{"type":"string","description":"Human-readable error message","example":"No such quiz: quiz_abc123","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"The parameter related to the error, if applicable","example":"id","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The parameter related to the error, if applicable","example":"id","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"doc_url":{"type":"string","format":"uri","description":"URL to documentation about this error","example":"https://docs.doozy.live/api/errors#resource_not_found","uniqueKey":"error.doc_url","typeLabel":"string\u003curi>"}},"required":["type","code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"invalid_request_error","code":"resource_not_found","message":"No such quiz: quiz_abc123","param":"id","doc_url":"https://docs.doozy.live/api/errors#resource_not_found"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"b1bc6897-5bd8-4091-a725-65a3e1849e26":{"apiKey":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication. Generate keys in the Doozy dashboard.","scopes":[],"schemeName":"apiKey"}}},"servers":{"5b6ba15e-bfcd-4066-979f-bcc84b7fa805":{"url":"https://api.doozy.live","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key for authentication. Generate keys in the Doozy dashboard.","scopes":[],"schemeName":"apiKey"},"schema":{"title":"x-api-key","type":"string","description":"API key for authentication. Generate keys in the Doozy dashboard.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"x-api-key"}],"title":"apiKey"}]},"originalFileLocation":"openapi.json"},"subdomain":"doozy","siteName":"Doozy Help","title":"Get survey details - Doozy Help","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-21T20:29:04.467Z","originalFileLocation":"api-reference/surveys/get-survey-details.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve a specific survey by ID, including questions and delivery instances. Only accessible if the user is an admin of the survey.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Doozy Help\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/doozy/MlVCMwDZ0Q_kkiap/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/doozy/MlVCMwDZ0Q_kkiap/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/doozy/MlVCMwDZ0Q_kkiap/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/doozy/MlVCMwDZ0Q_kkiap/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/doozy/MlVCMwDZ0Q_kkiap/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/doozy/MlVCMwDZ0Q_kkiap/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/doozy/MlVCMwDZ0Q_kkiap/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/doozy/MlVCMwDZ0Q_kkiap/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/doozy/MlVCMwDZ0Q_kkiap/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get survey details - Doozy Help\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve a specific survey by ID, including questions and delivery instances. Only accessible if the user is an admin of the survey.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Doozy Help\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://help.doozy.live/api-reference/surveys/get-survey-details\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://doozy.mintlify.app/_mintlify/api/og/v2?division=Surveys\u0026amp;title=Get+survey+details\u0026amp;description=Retrieve+a+specific+survey+by+ID%2C+including+questions+and+delivery+instances.+Only+accessible+if+the+user+is+an+admin+of+the+survey.\u0026amp;theme=c9ad9a61c38805f1fee7707e\u0026amp;signature=2009a6b2fc3dc53c6f0ecd66c89e142320d6d82ad127085c40c50eb8d9c4888c\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get survey details - Doozy Help\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve a specific survey by ID, including questions and delivery instances. Only accessible if the user is an admin of the survey.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://doozy.mintlify.app/_mintlify/api/og/v2?division=Surveys\u0026amp;title=Get+survey+details\u0026amp;description=Retrieve+a+specific+survey+by+ID%2C+including+questions+and+delivery+instances.+Only+accessible+if+the+user+is+an+admin+of+the+survey.\u0026amp;theme=c9ad9a61c38805f1fee7707e\u0026amp;signature=2009a6b2fc3dc53c6f0ecd66c89e142320d6d82ad127085c40c50eb8d9c4888c\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/doozy/MlVCMwDZ0Q_kkiap/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Doozy Help\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#111\">\u003clink data-mint-head rel=\"canonical\" href=\"https://help.doozy.live/api-reference/surveys/get-survey-details\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/surveys/get-survey-details.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://help.doozy.live/#organization\",\"name\":\"Doozy Help\",\"url\":\"https://help.doozy.live\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/doozy/YYQnSHcaAxwTvoP-/logo/light.svg?fit=max\u0026auto=format\u0026n=YYQnSHcaAxwTvoP-\u0026q=85\u0026s=7e15b956e576b83b95e9b26c2318e976\"}},{\"@type\":\"WebSite\",\"@id\":\"https://help.doozy.live#website\",\"name\":\"Doozy Help\",\"url\":\"https://help.doozy.live\",\"publisher\":{\"@id\":\"https://help.doozy.live/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://help.doozy.live/api-reference/surveys/get-survey-details#webpage\",\"url\":\"https://help.doozy.live/api-reference/surveys/get-survey-details\",\"name\":\"Get survey details\",\"description\":\"Retrieve a specific survey by ID, including questions and delivery instances. Only accessible if the user is an admin of the survey.\",\"dateModified\":\"2026-10-21T20:29:04.467Z\",\"isPartOf\":{\"@id\":\"https://help.doozy.live#website\"},\"breadcrumb\":{\"@id\":\"https://help.doozy.live/api-reference/surveys/get-survey-details#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://help.doozy.live/api-reference/surveys/get-survey-details#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://help.doozy.live/api-reference/quizzes/list-quizzes\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Surveys\",\"item\":\"https://help.doozy.live/api-reference/surveys/list-surveys\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get survey details\",\"item\":\"https://help.doozy.live/api-reference/surveys/get-survey-details\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://help.doozy.live/api-reference/surveys/get-survey-details#apireference\",\"headline\":\"Get survey details\",\"name\":\"Get survey details\",\"description\":\"Retrieve a specific survey by ID, including questions and delivery instances. Only accessible if the user is an admin of the survey.\",\"url\":\"https://help.doozy.live/api-reference/surveys/get-survey-details\",\"mainEntityOfPage\":{\"@id\":\"https://help.doozy.live/api-reference/surveys/get-survey-details#webpage\"},\"dateModified\":\"2026-10-21T20:29:04.467Z\",\"publisher\":{\"@id\":\"https://help.doozy.live/#organization\"},\"isPartOf\":{\"@id\":\"https://help.doozy.live#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Doozy Help\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Doozy Help","nav":{"global":{"tabs":[{"tab":"Security \u0026 Privacy","href":"https://doozy.live/security"},{"tab":"Status","href":"https://status.doozy.live"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/getting-started/what-is-doozy"}]},{"tab":"API Reference","groups":[{"group":"Getting Started","pages":[{"title":"API Overview","sidebarTitle":"Overview","href":"/api/overview"},{"title":"MCP reporting","sidebarTitle":"MCP reporting","href":"/api/mcp"},{"title":"Authentication","sidebarTitle":"Authentication","href":"/api/authentication"},{"title":"Error Handling","sidebarTitle":"Errors","href":"/api/errors"}]},{"group":"Integrations","pages":[{"title":"Calling the API from Make","sidebarTitle":"Make","href":"/api/integrations/make"},{"title":"Calling the API from Zapier","sidebarTitle":"Zapier","href":"/api/integrations/zapier"}]},{"group":"API reference","pages":[{"group":"Quizzes","pages":[{"title":"List quizzes","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/quizzes","href":"/api-reference/quizzes/list-quizzes"},{"title":"Get quiz details","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/quizzes/{quizId}","href":"/api-reference/quizzes/get-quiz-details"},{"title":"Get quiz report","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/quizzes/{quizId}/report","href":"/api-reference/quizzes/get-quiz-report"}]},{"group":"Quiz Instances","pages":[{"title":"List quiz instances","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/quizzes/{quizId}/instances","href":"/api-reference/quiz-instances/list-quiz-instances"},{"title":"Get quiz instance","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/quizzes/{quizId}/instances/{instanceId}","href":"/api-reference/quiz-instances/get-quiz-instance"}]},{"group":"Quiz Reports","pages":[{"title":"Get a participant's quiz result","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/quizzes/{quizId}/instances/{instanceId}/participants/{userId}","href":"/api-reference/quiz-reports/get-a-participants-quiz-result"}]},{"group":"Tracks","pages":[{"title":"List tracks","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/tracks","href":"/api-reference/tracks/list-tracks"},{"title":"Get track details","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/tracks/{trackId}","href":"/api-reference/tracks/get-track-details"},{"title":"Get track report","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/tracks/{trackId}/report","href":"/api-reference/tracks/get-track-report"},{"title":"Get a track instance","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/tracks/{trackId}/instances/{instanceId}","href":"/api-reference/tracks/get-a-track-instance"},{"title":"Enroll user in track","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/tracks/{trackId}/enroll","href":"/api-reference/tracks/enroll-user-in-track"}]},{"group":"Surveys","pages":[{"title":"List surveys","description":"List all surveys accessible to the authenticated user. Returns surveys where the user is an admin. Results are paginated and sorted by creation date (newest first). Only polls and surveys are returned (excludes activity feedback).","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/surveys","href":"/api-reference/surveys/list-surveys"},{"title":"Get survey details","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/surveys/{surveyId}","href":"/api-reference/surveys/get-survey-details"},{"title":"Get survey report","description":"Retrieve a detailed analytics report for a survey, including summary statistics, per-question analytics with breakdowns, and a paginated participant list. For anonymous surveys, only responded participants can be returned.","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/surveys/{surveyId}/report","href":"/api-reference/surveys/get-survey-report"},{"title":"Get a respondent's survey result","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/surveys/{surveyId}/instances/{instanceId}/participants/{userId}","href":"/api-reference/surveys/get-a-respondents-survey-result"},{"title":"Get survey trends","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/surveys/{surveyId}/trends","href":"/api-reference/surveys/get-survey-trends"}]},{"group":"Introductions","pages":[{"title":"List introductions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/introductions","href":"/api-reference/introductions/list-introductions"},{"title":"Get track introductions report","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/introductions/report","href":"/api-reference/introductions/get-track-introductions-report"},{"title":"Get introduction details","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/introductions/{introductionId}","href":"/api-reference/introductions/get-introduction-details"},{"title":"List introduction instances","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/introductions/{introductionId}/instances","href":"/api-reference/introductions/list-introduction-instances"},{"title":"Get introduction report","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/introductions/{introductionId}/report","href":"/api-reference/introductions/get-introduction-report"}]},{"group":"Account","pages":[{"title":"Get user provisioning settings","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/account/provisioning","href":"/api-reference/account/get-user-provisioning-settings"},{"title":"Update user provisioning settings","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/account/provisioning","href":"/api-reference/account/update-user-provisioning-settings"},{"title":"Preview a provisioning change","deprecated":null,"version":null,"openapi":"/openapi.json post /v1/account/provisioning/preview","href":"/api-reference/account/preview-a-provisioning-change"},{"title":"Get feature permissions","deprecated":null,"version":null,"openapi":"/openapi.json get /v1/account/permissions","href":"/api-reference/account/get-feature-permissions"},{"title":"Update feature permissions","deprecated":null,"version":null,"openapi":"/openapi.json patch /v1/account/permissions","href":"/api-reference/account/update-feature-permissions"}]}]}]}]},"title":"Get survey details - Doozy Help","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bbp7I60D.js","utils-C3RIvJha.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DqD-vLt8.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B31Loprg.js","snippetPresets-DKpk-b8t.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Cj65AhOR.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BXtn5gcC.js","shallow-RY2b03Cp.js","getApiPlaygroundDisplay-B0jeiPk3.js","CodeSnippet-CYgBjjwn.js","CodeSnippets-DOngDrYB.js","Page-n7I5XbKb.js","getPastedJson-DRQbJx-T.js","icon-CQiQCicY.js","MethodPill-BKTLdNtu.js","DuplicateIcon-B9jpAdat.js","createIcon-DCddRrXv.js","DynamicMarkdown-a8hUKrw6.js","SectionHeading-eECVV2eH.js","axios-vUo_bRtp.js","Markdown--GF7ZIpf.js","clsx-DZLdJUrt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-2LoAhjKH.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Zwc0ZncM.js"]}