{"_id":"5627ca9c22ef6a2100fb3513","parentDoc":null,"project":"55843604fd8d910d007b9502","user":"558435c2fb52ee0d0015d190","__v":75,"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"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-21T17:25:48.352Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":6,"body":"API responses will contain a JSON object with two fields: `result` and `meta`. If the API call returned any results the `result` field will contain a JSON object, otherwise, the `result` field will not be present. The `meta` field will return the status and any relevant error information.\n\nMost paginated responses have a default of **100** items returned under the `result` field. Some API calls will allow the user to override the default page size for paginated responses.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"result\\\": {\\n\\t\\t\\t...\\n  },\\n  \\\"meta\\\": {\\n    \\\"httpStatus\\\": \\\"200 - OK\\\"\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"200 OK\"\n    },\n    {\n      \"code\": \"{\\n  \\\"meta\\\": {\\n    \\\"httpStatus\\\": \\\"200 - OK\\\"\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"200 OK - No Result\"\n    },\n    {\n      \"code\": \"{\\n  \\\"meta\\\": {\\n    \\\"httpStatus\\\": \\\"404 - Not Found\\\",\\n    \\\"error\\\": {\\n      \\\"errorMessage\\\": \\\"API call does not exist: GET /API/v3/doesnotexist\\\"\\n    }\\n  }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Error Response Example\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"HTTP Response Codes\"\n}\n[/block]\nThe Qualtrics API uses a subset of all available HTTP status codes. These status codes are listed here with a brief explanation of what they each mean.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"HTTP Response Code\",\n    \"0-0\": \"200 - OK\",\n    \"1-0\": \"400 - Bad Request\",\n    \"2-0\": \"401 - Unauthorized\",\n    \"3-0\": \"404 - Not Found\",\n    \"0-1\": \"The request succeeded\",\n    \"1-1\": \"There was something invalid about the request.\",\n    \"2-1\": \"The api user could not be authenticated or does not have authorization to access the requested resource.\",\n    \"3-1\": \"The requested resource could not be found.\",\n    \"5-0\": \"429 - Too Many Requests\",\n    \"7-0\": \"503 - Temporary Internal Server Error\",\n    \"7-1\": \"This indicates a temporary outage internal to the Qualtrics API. You can either retry or contact <a href=\\\"https://www.qualtrics.com/contact/\\\" target=\\\"_blank\\\">Qualtrics Support</a> with the `instanceId` and `errorCode` found in the response.\",\n    \"6-1\": \"This indicates a problem internal to the Qualtrics API and usually cannot be corrected by the user. Please contact <a href=\\\"https://www.qualtrics.com/contact/\\\" target=\\\"_blank\\\">Qualtrics Support</a> with the `instanceId` and `errorCode` found in the response.\",\n    \"6-0\": \"500 - Internal Server Error\",\n    \"5-1\": \"You have reached the [concurrent request limit](https://api.qualtrics.com/docs/limits).\",\n    \"4-0\": \"413 - Request Entity Too Large\",\n    \"4-1\": \"The request body was too large. This can also happen in cases where a multipart/form-data request is malformed.\",\n    \"h-1\": \"Description\"\n  },\n  \"cols\": 2,\n  \"rows\": 8\n}\n[/block]","excerpt":"","slug":"response","type":"basic","title":"Responses"}
API responses will contain a JSON object with two fields: `result` and `meta`. If the API call returned any results the `result` field will contain a JSON object, otherwise, the `result` field will not be present. The `meta` field will return the status and any relevant error information. Most paginated responses have a default of **100** items returned under the `result` field. Some API calls will allow the user to override the default page size for paginated responses. [block:api-header] { "type": "basic", "title": "Examples", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"result\": {\n\t\t\t...\n },\n \"meta\": {\n \"httpStatus\": \"200 - OK\"\n }\n}", "language": "json", "name": "200 OK" }, { "code": "{\n \"meta\": {\n \"httpStatus\": \"200 - OK\"\n }\n}", "language": "json", "name": "200 OK - No Result" }, { "code": "{\n \"meta\": {\n \"httpStatus\": \"404 - Not Found\",\n \"error\": {\n \"errorMessage\": \"API call does not exist: GET /API/v3/doesnotexist\"\n }\n }\n}", "language": "json", "name": "Error Response Example" } ], "sidebar": true } [/block] [block:api-header] { "type": "basic", "title": "HTTP Response Codes" } [/block] The Qualtrics API uses a subset of all available HTTP status codes. These status codes are listed here with a brief explanation of what they each mean. [block:parameters] { "data": { "h-0": "HTTP Response Code", "0-0": "200 - OK", "1-0": "400 - Bad Request", "2-0": "401 - Unauthorized", "3-0": "404 - Not Found", "0-1": "The request succeeded", "1-1": "There was something invalid about the request.", "2-1": "The api user could not be authenticated or does not have authorization to access the requested resource.", "3-1": "The requested resource could not be found.", "5-0": "429 - Too Many Requests", "7-0": "503 - Temporary Internal Server Error", "7-1": "This indicates a temporary outage internal to the Qualtrics API. You can either retry or contact <a href=\"https://www.qualtrics.com/contact/\" target=\"_blank\">Qualtrics Support</a> with the `instanceId` and `errorCode` found in the response.", "6-1": "This indicates a problem internal to the Qualtrics API and usually cannot be corrected by the user. Please contact <a href=\"https://www.qualtrics.com/contact/\" target=\"_blank\">Qualtrics Support</a> with the `instanceId` and `errorCode` found in the response.", "6-0": "500 - Internal Server Error", "5-1": "You have reached the [concurrent request limit](https://api.qualtrics.com/docs/limits).", "4-0": "413 - Request Entity Too Large", "4-1": "The request body was too large. This can also happen in cases where a multipart/form-data request is malformed.", "h-1": "Description" }, "cols": 2, "rows": 8 } [/block]