{"_id":"570286fef2d6f336005e8f2b","category":{"_id":"558444cfafccfd0d00fcb2bc","pages":["558444cfafccfd0d00fcb2c0","558444cfafccfd0d00fcb2c1","558444cfafccfd0d00fcb2c2","558444cfafccfd0d00fcb2c3","55ad520e24cf160d0013587c","55ad522424cf160d0013587e","55ad52376aadf20d0015b788","55ad525433616a0d00599d59","55ad526333616a0d00599d5b","55ad526c24cf160d00135881","55d34302b9ef4435006dec83","55d349ca0168850d0073f099","55d34a4fb9ef4435006deca3","56aa8778cc0f740d005bc2c3","56d8ae52a957fb1500765aab","56eb0aceacc4bc0e00be05d1"],"__v":13,"project":"55843604fd8d910d007b9502","version":"558444ceafccfd0d00fcb2bb","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-06-19T15:47:34.696Z","from_sync":false,"order":6,"slug":"users","title":"Users"},"project":"55843604fd8d910d007b9502","parentDoc":null,"version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":45,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"user":"558435c2fb52ee0d0015d190","__v":1,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-04T15:23:42.163Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -H 'X-API-TOKEN: yourtokenhere' 'https://yourdatacenterid.qualtrics.com/API/v3/users'"}]},"method":"get","results":{"codes":[{"language":"json","code":"{\n  \"result\": {\n    \"elements\": [\n      {\n        \"id\": \"UR_012345678912345\",\n        \"divisionId\": null,\n        \"username\": \"jpicard\",\n        \"firstName\": \"Jean-Luc\",\n        \"lastName\": \"Picard\",\n        \"userType\": \"UT_BRANDADMIN\",\n        \"email\": \"jpicard:::at:::starfleet.mil\",\n        \"accountStatus\": \"active\"\n      },\n      {\n        \"id\": \"UR_987654321098765\",\n        \"divisionId\": null,\n        \"username\": \"wriker\",\n        \"firstName\": \"William\",\n        \"lastName\": \"Riker\",\n        \"userType\": \"UT_BRANDADMIN\",\n        \"email\": \"wriker@starfleet.mil\",\n        \"accountStatus\": \"active\"\n      }\n      ...\n    ],\n    \"nextPage\": \"https://yourdatacenterid.qualtrics.com/API/v3/users?offset=100\"\n  },\n  \"meta\": {\n    \"httpStatus\": \"200 - OK\"\n  }\n}","name":"","status":200},{"code":"{\n    \"meta\": {\n        \"error\": {\n            \"errorCode\": \"GU_1\",\n            \"errorMessage\": \"Insufficient permissions.\"\n        },\n        \"httpStatus\": \"401 - Unauthorized\",\n        \"requestId\": null\n    }\n}\n","language":"json","status":401}]},"settings":"","auth":"required","params":[],"url":"/v:version/users"},"isReference":false,"order":0,"body":"For more information about using the user APIs, see [Managing Users](doc:managing-users).\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Administrator Request\",\n  \"body\": \"To use this call you must be a Qualtrics brand administrator\"\n}\n[/block]","excerpt":"Gets all users in the collection","slug":"list-users","type":"endpoint","title":"List Users"}

getList Users

Gets all users in the collection

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format


Documentation

For more information about using the user APIs, see [Managing Users](doc:managing-users). [block:callout] { "type": "warning", "title": "Administrator Request", "body": "To use this call you must be a Qualtrics brand administrator" } [/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 }}