{"_id":"5627ca823a4c6b0d00c455eb","__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"},"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,"project":"55843604fd8d910d007b9502","user":"558435c2fb52ee0d0015d190","updates":["56f3089cc6d9e30e00590553","56f334b36f1bea0e003fc13e"],"next":{"pages":[],"description":""},"createdAt":"2015-10-21T17:25:22.015Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"The Qualtrics API uses HTTP verbs to operate on each collection and element.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"POST\",\n    \"h-1\": \"GET\",\n    \"h-2\": \"PUT\",\n    \"h-3\": \"DELETE\",\n    \"0-0\": \"Create\",\n    \"0-1\": \"Read\",\n    \"0-2\": \"Update\",\n    \"0-3\": \"Delete\"\n  },\n  \"cols\": 4,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example Requests\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /API/v3/users/UR_1234567890AbCdE HTTP/1.1\\nHost: yourdatacenterid.qualtrics.com\\nX-API-TOKEN: yourtokenhere\\n\",\n      \"language\": \"http\",\n      \"name\": \"GET\"\n    },\n    {\n      \"code\": \"DELETE /API/v3/users/UR_1234567890AbCdE HTTP/1.1\\nHost: yourdatacenterid.qualtrics.com\\nX-API-TOKEN: yourtokenhere\",\n      \"language\": \"http\",\n      \"name\": \"DELETE\"\n    },\n    {\n      \"code\": \"POST /API/v3/users HTTP/1.1\\nHost: yourdatacenterid.qualtrics.com\\nX-API-TOKEN: yourtokenhere\\nContent-Type: application/json\\n\\n{\\n    \\\"username\\\": \\\"exampleuser\\\",\\n    \\\"firstName\\\": \\\"ExampleFirstName\\\",\\n    \\\"lastName\\\": \\\"ExampleLastName\\\",\\n    \\\"userType\\\": \\\"UT_012345678912345\\\",\\n    \\\"password\\\": \\\"examplepassword\\\",\\n    \\\"email\\\": \\\"example:::at:::example.com\\\"\\n}\",\n      \"language\": \"http\",\n      \"name\": \"POST\"\n    },\n    {\n      \"code\": \"PUT /API/v3/users/UR_1234567890AbCdE HTTP/1.1\\nHost: yourdatacenterid.qualtrics.com\\nX-API-TOKEN: yourtokenhere\\nContent-Type: application/json\\n\\n{\\n    \\\"firstName\\\": \\\"ExampleFirstName\\\",\\n    \\\"email\\\": \\\"example@example.com\\\"\\n}\",\n      \"language\": \"http\",\n      \"name\": \"PUT\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"HTTP Methods\"\n}\n[/block]\n## HTTP GET/DELETE Requests\nThe parameters are passed using query string syntax. All parameters and values are case sensitive. For more information see <a href=\"http://en.wikipedia.org/wiki/Query_string\" target=\"_blank\">Query String Documentation</a>.\n\n## HTTP POST/PUT Requests\nMost POST and PUT requests accept parameters via the <a href=\"http://www.json.org/\" target=\"_blank\">application/json</a> content type. The only exception to this is for POST requests that accept files.\n\n## File uploads\nRequests that accept files, such as survey imports, use the <a href=\"https://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.2\" target=\"_blank\">multipart/form-data</a> content type.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Idempotent Requests\"\n}\n[/block]\nSome requests within the Qualtrics API enforce <a href=\"https://en.wikipedia.org/wiki/Idempotence\" target=\"_blank\">idempotency</a> for safely retrying requests without accidentally performing the same operation twice. For example, if a request to adjust the incentive points for a contact fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that the adjustment only happens once.\n\nWe will always send back the same response for requests made with the same key.","excerpt":"","slug":"parameters","type":"basic","title":"Parameters"}
The Qualtrics API uses HTTP verbs to operate on each collection and element. [block:parameters] { "data": { "h-0": "POST", "h-1": "GET", "h-2": "PUT", "h-3": "DELETE", "0-0": "Create", "0-1": "Read", "0-2": "Update", "0-3": "Delete" }, "cols": 4, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Example Requests", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "GET /API/v3/users/UR_1234567890AbCdE HTTP/1.1\nHost: yourdatacenterid.qualtrics.com\nX-API-TOKEN: yourtokenhere\n", "language": "http", "name": "GET" }, { "code": "DELETE /API/v3/users/UR_1234567890AbCdE HTTP/1.1\nHost: yourdatacenterid.qualtrics.com\nX-API-TOKEN: yourtokenhere", "language": "http", "name": "DELETE" }, { "code": "POST /API/v3/users HTTP/1.1\nHost: yourdatacenterid.qualtrics.com\nX-API-TOKEN: yourtokenhere\nContent-Type: application/json\n\n{\n \"username\": \"exampleuser\",\n \"firstName\": \"ExampleFirstName\",\n \"lastName\": \"ExampleLastName\",\n \"userType\": \"UT_012345678912345\",\n \"password\": \"examplepassword\",\n \"email\": \"example@example.com\"\n}", "language": "http", "name": "POST" }, { "code": "PUT /API/v3/users/UR_1234567890AbCdE HTTP/1.1\nHost: yourdatacenterid.qualtrics.com\nX-API-TOKEN: yourtokenhere\nContent-Type: application/json\n\n{\n \"firstName\": \"ExampleFirstName\",\n \"email\": \"example@example.com\"\n}", "language": "http", "name": "PUT" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "HTTP Methods" } [/block] ## HTTP GET/DELETE Requests The parameters are passed using query string syntax. All parameters and values are case sensitive. For more information see <a href="http://en.wikipedia.org/wiki/Query_string" target="_blank">Query String Documentation</a>. ## HTTP POST/PUT Requests Most POST and PUT requests accept parameters via the <a href="http://www.json.org/" target="_blank">application/json</a> content type. The only exception to this is for POST requests that accept files. ## File uploads Requests that accept files, such as survey imports, use the <a href="https://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.2" target="_blank">multipart/form-data</a> content type. [block:api-header] { "type": "basic", "title": "Idempotent Requests" } [/block] Some requests within the Qualtrics API enforce <a href="https://en.wikipedia.org/wiki/Idempotence" target="_blank">idempotency</a> for safely retrying requests without accidentally performing the same operation twice. For example, if a request to adjust the incentive points for a contact fails due to a network connection error, you can retry the request with the same idempotency key to guarantee that the adjustment only happens once. We will always send back the same response for requests made with the same key.