{"_id":"553a97ba69c2630d00a8562f","user":"55356ede6040a20d00454508","version":{"_id":"553591cd63cc650d00312925","project":"55357364e02d480d0003c6d3","__v":13,"forked_from":"55357365e02d480d0003c6d6","createdAt":"2015-04-20T23:54:53.134Z","releaseDate":"2015-04-20T23:54:53.134Z","categories":["553591cd63cc650d00312926","553591cd63cc650d00312927","5536e4d39f7f2d0d00b1cd54","5536e55c20d5ca0d0001580a","5536e6bf7fe60f0d000fd1c0","5536f5bba171250d00c00556","553a974369c2630d00a8562e","553a97c60074c80d00621c2a","553a98332af5f20d000fc32a","553a9b9869c2630d00a85642","556e0f23d02e0b190042f13d","563249b1dcc27a1700823650","5639113f049e420d00476b03","59a5dd94aaa11d003334edb4"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"editedParams":true,"__v":1,"category":{"_id":"553a974369c2630d00a8562e","project":"55357364e02d480d0003c6d3","__v":2,"pages":["553a97ba69c2630d00a8562f","55b91def146ef1210021586f"],"version":"553591cd63cc650d00312925","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-04-24T19:19:31.426Z","from_sync":false,"order":3,"slug":"groups","title":"Groups"},"editedParams2":true,"project":"55357364e02d480d0003c6d3","parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-04-24T19:21:30.407Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"code":"GET https://api.goformz.com/v2/groups?sort=name","language":"http","name":""}]},"method":"get","results":{"codes":[{"name":"","code":"[\n  {\n    \"id\": \"5be9f3b6-34f0-4d09-a127-a397e673fd90\",\n    \"name\": \"ABC Group\",\n    \"url\": \"https://api.goformz.com/v2/groups/5be9f3b6-34f0-4d09-a127-a397e673fd90\"\n  },\n  {\n    \"id\": \"e3f500ba-35be-4dcc-a7eb-6c5b402057d0\",\n    \"name\": \"no access\",\n    \"url\": \"https://api.goformz.com/v2/groups/e3f500ba-35be-4dcc-a7eb-6c5b402057d0\"\n  },\n  {\n    \"id\": \"540a73be-db2b-4ef1-bb6c-95e82a8696b6\",\n    \"name\": \"Test Group\",\n    \"url\": \"https://api.goformz.com/v2/groups/540a73be-db2b-4ef1-bb6c-95e82a8696b6\"\n  }\n]","language":"json","status":200}]},"auth":"required","params":[{"_id":"553a97ba69c2630d00a85631","ref":"","in":"query","required":false,"desc":"The field name to sort on, optionally you can specify a direction (asc or desc).","default":"","type":"string","name":"sort"},{"_id":"553a97ba69c2630d00a85630","ref":"","in":"query","required":false,"desc":"Returns only groups where the name starts with the specified string.","default":"","type":"string","name":"name"}],"url":"/groups"},"isReference":false,"order":1,"body":"Returns the paginated result from the specified parameters. See <a href=\"http://developers.goformz.com/docs/pagination\" alt=\"pagination\">Pagination</a> for more details.\n\n</br><a href=\"https://api.goformz.com/docs/api/explorer/index#!/Groups/Groups_Get\" target=\"_blank\"><img src=\"https://files.readme.io/9Z82WIZnS7mZmco8oi4u_TryItNow3.png\" style=\"margin-left:15px\" width=\"128\" height=\"42\" ></a>","excerpt":"","slug":"get-a-list-of-groups","type":"endpoint","title":"Get a List of Groups"}

getGet a List of Groups


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

sort:
string
The field name to sort on, optionally you can specify a direction (asc or desc).
name:
string
Returns only groups where the name starts with the specified string.

Examples


Result Format


Documentation

Returns the paginated result from the specified parameters. See <a href="http://developers.goformz.com/docs/pagination" alt="pagination">Pagination</a> for more details. </br><a href="https://api.goformz.com/docs/api/explorer/index#!/Groups/Groups_Get" target="_blank"><img src="https://files.readme.io/9Z82WIZnS7mZmco8oi4u_TryItNow3.png" style="margin-left:15px" width="128" height="42" ></a>