{"_id":"5702893a12b0f11900f9d5ed","category":{"_id":"55ad4d0d24cf160d00135852","version":"558444ceafccfd0d00fcb2bb","__v":11,"pages":["55ad4ee224cf160d00135861","55ad4ef524cf160d00135863","55ad4f1c33616a0d00599d3a","55ad4f2b33616a0d00599d3c","55ad4f3533616a0d00599d3e","55d342c70168850d0073f07e","55d34463b9ef4435006dec85","55d344beb9ef4435006dec86","55d34507b9ef4435006dec87","55d347620168850d0073f088","55d34844f77e6d0d00b1b013"],"project":"55843604fd8d910d007b9502","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-07-20T19:33:33.532Z","from_sync":false,"order":7,"slug":"groups","title":"Groups"},"__v":1,"editedParams":true,"editedParams2":true,"user":"558435c2fb52ee0d0015d190","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","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-04-04T15:33:14.101Z","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/groups'"}]},"method":"get","results":{"codes":[{"name":"","code":"{\n  \"result\": {\n    \"elements\": [\n      {\n        \"id\": \"GR_1234567890AbCdE\",\n        \"name\": \"Marketing\"\n      },\n      {\n        \"id\": \"GR_1234567890AbCdF\",\n        \"name\": \"Sales\"\n      }\n    ],\n    \"nextPage\": null\n  },\n  \"meta\": {\n    \"httpStatus\": \"200 - OK\"\n  }\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"564e1ab025ba4f21000a95e0","ref":"","in":"query","required":false,"desc":"Only include groups assigned to this division","default":"","type":"string","name":"divisionId"},{"_id":"595fb4652290d30015cd19b8","ref":"","in":"query","required":false,"desc":"The starting offset for the pagination. The default offset is 0. If there are additional pages, the offset value for the next page will be appended to the value of the nextPage parameter in the response.","default":"","type":"int","name":"offset"}],"url":"/v:version/groups"},"isReference":false,"order":0,"body":"[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 list of all groups known to the user account","slug":"list-groups","type":"endpoint","title":"List Groups"}

getList Groups

Gets list of all groups known to the user account

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

divisionId:
string
Only include groups assigned to this division
offset:
integer
The starting offset for the pagination. The default offset is 0. If there are additional pages, the offset value for the next page will be appended to the value of the nextPage parameter in the response.

Examples


Result Format


Documentation

[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 }}