{"_id":"553a982669c2630d00a85634","category":{"_id":"553a97c60074c80d00621c2a","project":"55357364e02d480d0003c6d3","version":"553591cd63cc650d00312925","pages":["553a982669c2630d00a85634","55b91f2bfeef5135009b7da3"],"__v":2,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-04-24T19:21:42.554Z","from_sync":false,"order":5,"slug":"users","title":"Users"},"project":"55357364e02d480d0003c6d3","editedParams":true,"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"},"user":"55356ede6040a20d00454508","__v":1,"editedParams2":true,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-04-24T19:23:18.001Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"[\n  {\n    \"id\": \"647350d6-85c8-4e31-923a-27ddbad38c5e\",\n    \"username\": \"test:::at:::sample.com\",\n    \"firstName\": \"John\",\n    \"lastName\": \"Sample\",\n    \"url\": \"https://api.goformz.com/v2/Users/647350d6-85c8-4e31-923a-27ddbad38c5e\"\n  },\n  {\n    \"id\": \"338d73d4-5dbf-42a9-8714-d51cac81c63a\",\n    \"username\": \"sample@sample.com\",\n    \"firstName\": \"Mary\",\n    \"lastName\": \"Sample\",\n    \"url\": \"https://api.goformz.com/v2/Users/338d73d4-5dbf-42a9-8714-d51cac81c63a\"\n  },\n  {\n    \"id\": \"97f28f74-434f-42f1-9927-138c23c4da81\",\n    \"username\": \"testuser@sample.com\",\n    \"firstName\": \"Jen\",\n    \"lastName\": \"Tester\",\n    \"url\": \"https://api.goformz.com/v2/Users/97f28f74-434f-42f1-9927-138c23c4da81\"\n  }\n]","language":"json","status":200}]},"settings":"","examples":{"codes":[{"name":"","code":"GET https://api.goformz.com/v2/users","language":"http"}]},"method":"get","auth":"required","params":[{"_id":"553a982669c2630d00a85636","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":"553a982669c2630d00a85635","ref":"","in":"query","required":false,"desc":"Returns only users where the name starts with the specified string.","default":"","type":"string","name":"name"}],"url":"/users"},"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#!/Users/Users_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-users","type":"endpoint","title":"Get a List of Users"}

getGet a List of Users


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 users 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#!/Users/Users_Get" target="_blank"><img src="https://files.readme.io/9Z82WIZnS7mZmco8oi4u_TryItNow3.png" style="margin-left:15px" width="128" height="42" ></a>