{"_id":"57028b58adbd340e00928bc2","version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":55,"createdAt":"2015-06-19T16:35:26.435Z","releaseDate":"2015-06-19T16:35:26.435Z","categories":["558444cfafccfd0d00fcb2bc","558444cfafccfd0d00fcb2bd","55ad4ce733616a0d00599d2e","55ad4cef6aadf20d0015b764","55ad4cf36aadf20d0015b765","55ad4cfb24cf160d0013584f","55ad4d0024cf160d00135850","55ad4d0a24cf160d00135851","55ad4d0d24cf160d00135852","55ad4d126aadf20d0015b766","55ad4d1624cf160d00135853","55ad4d1933616a0d00599d2f","55ad4d2233616a0d00599d30","55ad4d2e24cf160d00135854","55d35b6bf77e6d0d00b1b092","55d3649a0168850d0073f14a","55d366d40168850d0073f15a","55d37fcff77e6d0d00b1b13f","55d383e50168850d0073f1e1","55d3ac26c336ec0d007c2251","55d3c51cb2330119009c31db","55d3c59bfe37111900e536f3","55d3c5a7fe37111900e536f4","55d3c5b4fe37111900e536f5","55d3c5d4fe37111900e536f6","55d3c5d6b2330119009c31df","55d3c5d71f478b170077c164","55d3c687b2330119009c31e4","55d3c6a4fe37111900e536f9","55d3c6befe37111900e536fa","55d3c6e8d2c66f0d00497f93","55d49dcfd7c16b2d007de905","55d4ca8f5082980d0009c79b","55d4cab9c95a3d2f0069ad3d","55d4d279c95a3d2f0069ad60","55d4d9355082980d0009c7e1","55d4f6b5988e130d000b3eb1","55d64dc8e60a2f0d00b88ecb","5627ca43fcbbc621004ec07d","56c64a0d8f98b50d0012c37c","56f1b8b13eb62a34003ea041","56f1b9df4476fb2200795e8c","57f6907dca5e5d1700039ae9","591dd06ca266c423002ec4ca","59234825e465c11900922518","5936f82eaa591e0027638d57","59972f54fd7078001992c136","599c6da8f180820025f14909","59b054613c3e1b0019cf27d9","59b1ceca2d6231003ad73e5f","59b1cf1857911600382e0dc4","59b1cf2730f3d60010c30ef7","59b1cf385d4b89003035441a","59b1cf5857911600382e0dc6","59bc2c4e26ac9b0010a8b753","59bc2ce20b3eb30010657b70"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"parentDoc":null,"project":"55843604fd8d910d007b9502","user":"558435c2fb52ee0d0015d190","__v":1,"category":{"_id":"558444cfafccfd0d00fcb2bd","pages":["558444cfafccfd0d00fcb2be","558444cfafccfd0d00fcb2bf","55ad50d524cf160d00135877","55ad50ed33616a0d00599d4e","55ad511833616a0d00599d50","55ad51446aadf20d0015b784","55ad516033616a0d00599d52","55ad516e33616a0d00599d54","55ad517d24cf160d00135879","55ad771933616a0d00599e16","55d34b160168850d0073f09f","55d34d0df77e6d0d00b1b02f","55d3523ff77e6d0d00b1b059","55d35450b9ef4435006dece4","55d3549a0168850d0073f0db","55d354aa0168850d0073f0dc","55d354f20168850d0073f0df","55d3552e0168850d0073f0e2","55d35558b9ef4435006decef","55d35575f77e6d0d00b1b06f","55d355a2b9ef4435006decf3","56df156a3df5cb2000bb994b"],"project":"55843604fd8d910d007b9502","__v":21,"version":"558444ceafccfd0d00fcb2bb","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-06-19T16:24:31.047Z","from_sync":false,"order":9,"slug":"surveys","title":"Surveys"},"editedParams":true,"editedParams2":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-04T15:42:16.105Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl -H 'X-API-TOKEN: youtapitoken' 'https://yourdatacenterid.qualtrics.com/API/v3/surveys/SV_012345678912345'","language":"curl"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"result\": {\n    \"id\": \"SV_123456789012345\",\n    \"name\": “Example Survey\",\n    \"ownerId\": \"UR_abcdefghijklmno\",\n    \"organizationId\": “Example Organization\",\n    \"isActive\": false,\n    \"creationDate\": \"2017-05-09T16:07:12Z\",\n    \"lastModifiedDate\": \"2017-05-09T16:10:31Z\",\n    \"expiration\": {\n      \"startDate\": null,\n      \"endDate\": null\n    },\n    \"questions\": {\n      \"QID1\": {\n        \"questionType\": {\n          \"type\": \"MC\",\n          \"selector\": \"SAVR\",\n          \"subSelector\": \"TX\"\n        },\n        \"questionText\": \"Multiple Choice Question\",\n        \"questionLabel\": null,\n        \"validation\": {\n          \"doesForceResponse\": false\n        },\n        \"questionName\": \"Q1\",\n        \"choices\": {\n          \"1\": {\n            \"recode\": \"1\",\n            \"description\": \"Choice 1\",\n            \"choiceText\": \"Choice 1\",\n            \"imageDescription\": null,\n            \"variableName\": null,\n            \"analyze\": true\n          },\n          \"2\": {\n            \"recode\": \"2\",\n            \"description\": \"Choice 2\",\n            \"choiceText\": \"Choice 2\",\n            \"imageDescription\": null,\n            \"variableName\": null,\n            \"analyze\": true\n          },\n          \"3\": {\n            \"recode\": \"3\",\n            \"description\": \"Choice 3\",\n            \"choiceText\": \"Choice 3\",\n            \"imageDescription\": null,\n            \"variableName\": null,\n            \"analyze\": true\n          }\n        }\n      },\n      \"QID2\": {\n        \"questionType\": {\n          \"type\": \"TE\",\n          \"selector\": \"SL\",\n          \"subSelector\": null\n        },\n        \"questionText\": \"Text Entry Question\",\n        \"questionLabel\": null,\n        \"validation\": {\n          \"doesForceResponse\": false\n        },\n        \"questionName\": \"Q2\"\n      },\n      \"QID3\": {\n        \"questionType\": {\n          \"type\": \"Matrix\",\n          \"selector\": \"Likert\",\n          \"subSelector\": \"SingleAnswer\"\n        },\n        \"questionText\": \"Matrix Question\",\n        \"questionLabel\": null,\n        \"validation\": {\n          \"doesForceResponse\": false\n        },\n        \"questionName\": \"Q3\",\n        \"subQuestions\": {\n          \"1\": {\n            \"recode\": \"1\",\n            \"description\": \"Statement 1\",\n            \"choiceText\": \"Statement 1\",\n            \"variableName\": null,\n            \"imageDescription\": null\n          },\n          \"2\": {\n            \"recode\": \"2\",\n            \"description\": \"Statement 2\",\n            \"choiceText\": \"Statement 2\",\n            \"variableName\": null,\n            \"imageDescription\": null\n          },\n          \"3\": {\n            \"recode\": \"3\",\n            \"description\": \"Statement 3\",\n            \"choiceText\": \"Statement 3\",\n            \"variableName\": null,\n            \"imageDescription\": null\n          }\n        },\n        \"choices\": {\n          \"1\": {\n            \"recode\": \"1\",\n            \"description\": \"Scale Point 1\",\n            \"choiceText\": \"Scale Point 1\",\n            \"imageDescription\": null,\n            \"analyze\": true\n          },\n          \"2\": {\n            \"recode\": \"2\",\n            \"description\": \"Scale Point 2\",\n            \"choiceText\": \"Scale Point 2\",\n            \"imageDescription\": null,\n            \"analyze\": true\n          },\n          \"3\": {\n            \"recode\": \"3\",\n            \"description\": \"Scale Point 3\",\n            \"choiceText\": \"Scale Point 3\",\n            \"imageDescription\": null,\n            \"analyze\": true\n          }\n        }\n      }\n    },\n    \"exportColumnMap\": {\n      \"Q1\": {\n        \"question\": \"QID1\"\n      },\n      \"Q2\": {\n        \"question\": \"QID2\"\n      },\n      \"Q3_1(1)\": {\n        \"question\": \"QID3\",\n        \"subQuestion\": \"QID3.subQuestions.1\"\n      },\n      \"Q3_2(1)\": {\n        \"question\": \"QID3\",\n        \"subQuestion\": \"QID3.subQuestions.2\"\n      },\n      \"Q3_3(1)\": {\n        \"question\": \"QID3\",\n        \"subQuestion\": \"QID3.subQuestions.3\"\n      },\n      \"Q3_1(2)\": {\n        \"question\": \"QID3\",\n        \"subQuestion\": \"QID3.subQuestions.1\"\n      },\n      \"Q3_2(2)\": {\n        \"question\": \"QID3\",\n        \"subQuestion\": \"QID3.subQuestions.2\"\n      },\n      \"Q3_3(2)\": {\n        \"question\": \"QID3\",\n        \"subQuestion\": \"QID3.subQuestions.3\"\n      },\n      \"Q3_1(3)\": {\n        \"question\": \"QID3\",\n        \"subQuestion\": \"QID3.subQuestions.1\"\n      },\n      \"Q3_2(3)\": {\n        \"question\": \"QID3\",\n        \"subQuestion\": \"QID3.subQuestions.2\"\n      },\n      \"Q3_3(3)\": {\n        \"question\": \"QID3\",\n        \"subQuestion\": \"QID3.subQuestions.3\"\n      }\n    },\n    \"blocks\": {\n      \"BL_9ozqTRwJd1omzYh\": {\n        \"description\": \"Default Question Block\",\n        \"elements\": [\n          {\n            \"type\": \"Question\",\n            \"questionId\": \"QID1\"\n          },\n          {\n            \"type\": \"Question\",\n            \"questionId\": \"QID2\"\n          }\n        ]\n      },\n      \"BL_bHLebbhgybqzmLP\": {\n        \"description\": \"Block 1\",\n        \"elements\": [\n          {\n            \"type\": \"Question\",\n            \"questionId\": \"QID3\"\n          }\n        ]\n      }\n    },\n    \"flow\": [\n      {\n        \"id\": \"BL_9ozqTRwJd1omzYh\",\n        \"type\": \"Block\"\n      },\n      {\n        \"id\": \"BL_bHLebbhgybqzmLP\",\n        \"type\": \"Block\"\n      }\n    ],\n    \"embeddedData\": [\n      {\n        \"name\": \"Embedded Data Field\",\n        \"defaultValue\": \"Embedded data field value\"\n      }\n    ],\n    \"comments\": {},\n    \"loopAndMerge\": {\n      \"BL_bHLebbhgybqzmLP\": {\n        \"loopType\": \"Question\",\n        \"loopQuestionMeta\": {\n          \"questionId\": \"QID1\",\n          \"questionType\": \"MC\",\n          \"loopOn\": [\n            {\n              \"criterion\": \"UnselectedChoices\"\n            }\n          ]\n        },\n        \"randomizationMeta\": {\n          \"randomize\": \"Subset\",\n          \"limit\": \"1\"\n        },\n        \"columnNames\": {\n          \"field1\": [\n            \"Choice 1\",\n            \"Choice 2\",\n            \"Choice 3\"\n          ],\n          \"field2\": [\n            \"alice\",\n            \"bob\",\n            \"charlie\"\n          ]\n        }\n      }\n    },\n    \"responseCounts\": {\n      \"auditable\": 0,\n      \"generated\": 0,\n      \"deleted\": 0\n    }\n  },\n  \"meta\": {\n    \"httpStatus\": \"200 - OK\",\n    \"requestId\": \"7309eb77-db6a-47bb-b818-4341aaca58f7\"\n  }\n}","name":""},{"language":"json","status":400,"code":"{\n    \"meta\": {\n        \"httpStatus\": \"400 - Bad Request\",\n        \"error\": {\n            \"errorMessage\": \"Missing or invalid surveyId\",\n            \"errorCode\": \"GSI_1\"\n        },\n        \"requestId\": null\n    }\n}"}]},"settings":"","auth":"required","params":[{"_id":"55ad78def302af23000abf5b","ref":"","in":"path","required":true,"desc":"Survey ID","default":"","type":"string","name":"surveyId"}],"url":"/v:version/surveys/:surveyId"},"isReference":false,"order":1,"body":"For more information about using the survey APIs, see [Managing Surveys](doc:managing-surveys).\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Survey Responses\",\n  \"body\": \"This API does not return your users' responses to your surveys. See [Getting Survey Responses](doc:response-exports) instead.\"\n}\n[/block]","excerpt":"Gets survey information","slug":"get-survey","type":"endpoint","title":"Get Survey"}

getGet Survey

Gets survey information

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

surveyId:
required
string
Survey ID

Examples


Result Format


Documentation

For more information about using the survey APIs, see [Managing Surveys](doc:managing-surveys). [block:callout] { "type": "info", "title": "Survey Responses", "body": "This API does not return your users' responses to your surveys. See [Getting Survey Responses](doc:response-exports) instead." } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}