{"__v":1,"_id":"56952277caa32519009c410a","category":{"__v":10,"_id":"5692b19ffe72e00d00e4f0a8","pages":["5692b1ec72d4580d0081e96b","5692b39b72d4580d0081e96f","56951b250c650a2300250544","569520590c650a2300250553","56952277caa32519009c410a","569523782e5eb41700901a7e","56992a43de42370d00727c7c","56b8acb443bbd10d0081d148","56ec413636bc8e0e00f190e3","56ec46068fac371700005d12"],"project":"563cc7119799fb0d00047685","version":"563cc7119799fb0d00047688","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-01-10T19:31:43.021Z","from_sync":false,"order":11,"slug":"fix-api","title":"Users"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"563cc7119799fb0d00047685","user":"563cc6fa8894d20d00014ea3","version":{"__v":16,"_id":"563cc7119799fb0d00047688","project":"563cc7119799fb0d00047685","createdAt":"2015-11-06T15:28:17.683Z","releaseDate":"2015-11-06T15:28:17.683Z","categories":["563cc7129799fb0d00047689","566f37f37ffa002300c3cd5b","56914e9bd47b020d002225ac","5692b19ffe72e00d00e4f0a8","56940bc2d8c04d1700e5adb6","56940bc83e9d080d00f064f0","56951b2dfcb1032d0089df7a","569522aecaa32519009c410c","569523ce562335190016da97","569523fddcaf0d1700cb86bf","56980e4a8560a60d00e2c3c3","569921a41693520d002e1305","5699323b7465970d00650b82","569e6cc4fbee990d0072d927","56a2768a0aefae0d00b7fe66","5862e862b8b7fa23009665b7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Model T","version_clean":"1.0.0","version":"1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-01-12T15:57:43.165Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"GET /v1/users?username=joesmith HTTP/1.1\nHost: api.drivewealth.io\nAccept: application/json\nContent-Type: application/json","language":"http"},{"code":"curl -X GET -H \"Accept: application/json\" -H \"Content-Type: application/json\" 'https://api.drivewealth.io/v1/users?username=joesmith'","language":"curl"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"code\": 200,\n    \"message\": \"Username found [username=joesmith]\"\n}","name":""},{"status":404,"language":"json","code":"{\n    \"code\": 404,\n    \"message\": \"Username not found [username=joesmith123]\"\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"5696739a7596a90d0014e5f6","ref":"","in":"path","required":true,"desc":"New username.","default":"joesmith","type":"string","name":"username"}],"url":"/users?username=:username"},"isReference":true,"order":2,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nEach response will contain a single object. Every object has a default list of attributes.\n[block:parameters]\n{\n  \"data\": {\n    \"h-1\": \"Description\",\n    \"h-0\": \"Attribute\",\n    \"0-0\": \"`\\\"code\\\"`\",\n    \"1-0\": \"`\\\"message\\\"`\",\n    \"0-1\": \"Message code. Set to `404` when username queried is available.\",\n    \"1-1\": \"Message about username availability.\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]","excerpt":"Check if user exists.","slug":"check-username-availability","type":"endpoint","title":"Check Username Availability"}

getCheck Username Availability

Check if user exists.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

username:
required
stringjoesmith
New username.

Examples


Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Response" } [/block] Each response will contain a single object. Every object has a default list of attributes. [block:parameters] { "data": { "h-1": "Description", "h-0": "Attribute", "0-0": "`\"code\"`", "1-0": "`\"message\"`", "0-1": "Message code. Set to `404` when username queried is available.", "1-1": "Message about username availability." }, "cols": 2, "rows": 2 } [/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 }}