{"_id":"588f722cbcace50f0052ba1d","__v":0,"user":"565f3941ea46251700972783","category":{"_id":"588f722bbcace50f0052b9e6","__v":0,"project":"565f5fa26bafd40d0030a064","version":"588f722bbcace50f0052b9e1","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-25T18:09:36.891Z","from_sync":false,"order":4,"slug":"dashboard-api","title":"Dashboard API"},"project":"565f5fa26bafd40d0030a064","version":{"_id":"588f722bbcace50f0052b9e1","project":"565f5fa26bafd40d0030a064","__v":1,"createdAt":"2017-01-30T17:04:43.410Z","releaseDate":"2017-01-30T17:04:43.410Z","categories":["588f722bbcace50f0052b9e2","588f722bbcace50f0052b9e3","588f722bbcace50f0052b9e4","588f722bbcace50f0052b9e5","588f722bbcace50f0052b9e6","588f722bbcace50f0052b9e7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"5.3.0","version":"5.3.0"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-22T22:31:33.980Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl -b cookies.txt -c cookies.txt -X GET \"https://api.nanoscale.io/users\""}]},"method":"get","results":{"codes":[{"code":"{\n    \"users\": [\n        {\n            \"id\": 95,\n            \"name\": \"Fizz Buzz\",\n            \"email\": \"fizzbuzz:::at:::nanoscale.io\",\n            \"admin\": false,\n            \"confirmed\": true\n        },\n        {\n            \"id\": 94,\n            \"name\": \"Foo Bar\",\n            \"email\": \"foobar@nanoscale.io\",\n            \"admin\": true,\n            \"confirmed\": true\n        }\n    ]\n}\n","name":"","status":200,"language":"json"}]},"settings":"","auth":"required","params":[],"url":"/users"},"isReference":true,"order":1,"body":"Calling the `/users` endpoint will return a collection of the defined `users` sorted alphabetically by name in ascending order.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"key\",\n    \"h-1\": \"type\",\n    \"h-2\": \"description\",\n    \"0-0\": \"`users`\",\n    \"0-1\": \"`array`\",\n    \"0-2\": \"array of the defined users\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\nEach `user` will have the following keys:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"key\",\n    \"h-1\": \"type\",\n    \"h-2\": \"description\",\n    \"0-0\": \"id\",\n    \"1-0\": \"name\",\n    \"2-0\": \"email\",\n    \"3-0\": \"admin\",\n    \"4-0\": \"confirmed\",\n    \"0-1\": \"`number`\",\n    \"1-1\": \"`string`\",\n    \"2-1\": \"`string`\",\n    \"3-1\": \"`boolean`\",\n    \"4-1\": \"`boolean`\",\n    \"0-2\": \"The user identifier.\",\n    \"1-2\": \"The name of the user.\",\n    \"2-2\": \"The email of the user.\",\n    \"3-2\": \"Indicates if the user is an administrator.\",\n    \"4-2\": \"Indicates if the user has confirmed their account.\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]","excerpt":"","slug":"users-1","type":"endpoint","title":"/users"}

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format


Documentation

Calling the `/users` endpoint will return a collection of the defined `users` sorted alphabetically by name in ascending order. [block:parameters] { "data": { "h-0": "key", "h-1": "type", "h-2": "description", "0-0": "`users`", "0-1": "`array`", "0-2": "array of the defined users" }, "cols": 3, "rows": 1 } [/block] Each `user` will have the following keys: [block:parameters] { "data": { "h-0": "key", "h-1": "type", "h-2": "description", "0-0": "id", "1-0": "name", "2-0": "email", "3-0": "admin", "4-0": "confirmed", "0-1": "`number`", "1-1": "`string`", "2-1": "`string`", "3-1": "`boolean`", "4-1": "`boolean`", "0-2": "The user identifier.", "1-2": "The name of the user.", "2-2": "The email of the user.", "3-2": "Indicates if the user is an administrator.", "4-2": "Indicates if the user has confirmed their account." }, "cols": 3, "rows": 5 } [/block]