{"_id":"5627ca593a4c6b0d00c455e9","project":"55843604fd8d910d007b9502","version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":60,"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","59f0c793ba3bc90030f413ab","59f0cd62f5ecda00325294b9","59fb55a8e8d0f600101aedc3","59fcb05c067f8d0028613f86","5a2af4a1bc5fba00283909c1"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"parentDoc":null,"user":"558435c2fb52ee0d0015d190","__v":86,"category":{"_id":"5627ca43fcbbc621004ec07d","project":"55843604fd8d910d007b9502","version":"558444ceafccfd0d00fcb2bb","__v":7,"pages":["5627ca593a4c6b0d00c455e9","5627ca6866c62617009d1844","5627ca823a4c6b0d00c455eb","5627ca9c22ef6a2100fb3513","56292b022c0fd9190067da82","5632ce9310b6040d0087944b","56df6582c0e74f0e00ba6ce6"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-21T17:24:19.325Z","from_sync":false,"order":0,"slug":"api","title":"API"},"updates":["56f319c34a8dae0e009ab3e3","56f31a1a5501280e008669cd","56f31ab4a0de870e003b6df2","56f31ae7c6d9e30e00590593","5744d67a6aa4860e00c2e127"],"next":{"pages":[],"description":""},"createdAt":"2015-10-21T17:24:41.600Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"The Qualtrics REST API allows you to query our system using a simple URL syntax. All API calls use `GET`, `POST`, `PUT`, or `DELETE` HTTP methods and return JSON.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Qualtrics REST API is a paid feature\",\n  \"body\": \"The API is an additional feature. If you are unsure if your account has API access, please contact the Qualtrics Administrator at your organization. If you are the Qualtrics Administrator please contact your sales representative at Qualtrics to discuss licensing for API access.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example Requests\"\n}\n[/block]\nExample requests are provided along with each call using cURL, a standard command line tool. You can modify these examples and test the calls from the command line. A nice alternative to experimenting with cURL is <a href=\"https://www.getpostman.com/\" target=\"_blank\">POSTMAN</a>, an easy-to-use Chrome extension for making HTTP requests.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Pagination\"\n}\n[/block]\nAll collection requests are paginated. You can page through the elements of the collection by making a GET request to the `nextPage` URL provided in the paged response. If there are no more pages, `nextPage` will be set to `null`.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"elements\\\": [\\n    { ... },\\n    { ... }\\n  ],\\n  \\\"nextPage\\\": \\\"https://yourdatacenterid.qualtrics.com/API/v3/example/path\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Paginated Response Example\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Getting Help\"\n}\n[/block]\nTo get help with the Qualtrics API, please contact <a href=\"https://www.qualtrics.com/contact-support/?Source=support\" target=\"_blank\">Qualtrics Support</a>. Include the API call or a clear outline of what you are trying to accomplish with the Qualtrics API.","excerpt":"","slug":"overview","type":"basic","title":"Overview"}
The Qualtrics REST API allows you to query our system using a simple URL syntax. All API calls use `GET`, `POST`, `PUT`, or `DELETE` HTTP methods and return JSON. [block:callout] { "type": "info", "title": "Qualtrics REST API is a paid feature", "body": "The API is an additional feature. If you are unsure if your account has API access, please contact the Qualtrics Administrator at your organization. If you are the Qualtrics Administrator please contact your sales representative at Qualtrics to discuss licensing for API access." } [/block] [block:api-header] { "type": "basic", "title": "Example Requests" } [/block] Example requests are provided along with each call using cURL, a standard command line tool. You can modify these examples and test the calls from the command line. A nice alternative to experimenting with cURL is <a href="https://www.getpostman.com/" target="_blank">POSTMAN</a>, an easy-to-use Chrome extension for making HTTP requests. [block:api-header] { "type": "basic", "title": "Pagination" } [/block] All collection requests are paginated. You can page through the elements of the collection by making a GET request to the `nextPage` URL provided in the paged response. If there are no more pages, `nextPage` will be set to `null`. [block:code] { "codes": [ { "code": "{\n \"elements\": [\n { ... },\n { ... }\n ],\n \"nextPage\": \"https://yourdatacenterid.qualtrics.com/API/v3/example/path\"\n}", "language": "json", "name": "Paginated Response Example" } ] } [/block] [block:api-header] { "type": "basic", "title": "Getting Help" } [/block] To get help with the Qualtrics API, please contact <a href="https://www.qualtrics.com/contact-support/?Source=support" target="_blank">Qualtrics Support</a>. Include the API call or a clear outline of what you are trying to accomplish with the Qualtrics API.