{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/check_username/","auth":"required","params":[{"name":"api_token","type":"string","default":"","desc":"An api token from dashboard.justyo.co","required":true,"in":"query","ref":"","_id":"5429e1527d3ab608001b0f16"},{"name":"username","type":"string","default":"","desc":"The username to check availability of","required":true,"in":"query","ref":"","_id":"54712e39691dc80800895310"}],"results":{"codes":[{"name":"Success","code":"{\"exists\": false}","language":"json","status":200},{"status":200,"name":"Failure","code":"{\"exists\": true}","language":"json"},{"language":"text","code":""}]},"settings":"","method":"get"},"next":{"description":"","pages":[]},"title":"/check_username/","type":"endpoint","slug":"check_username","excerpt":"Checks if a username exists","body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Result Format\"\n}\n[/block]\nIf the user **is available**:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\\"exists\\\": true}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nIf the user **is not available**:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\\"exists\\\": false}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","updates":["5583b0dafb52ee0d0015cffb"],"order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"55b96120b42b610d00c9b29d","category":{"sync":{"isSync":false,"url":""},"pages":["55b96120b42b610d00c9b29a","55b96120b42b610d00c9b29b","55b96120b42b610d00c9b29c","55b96120b42b610d00c9b29d","55b96120b42b610d00c9b29e","55b96120b42b610d00c9b29f","55b96120b42b610d00c9b2a0","55b96120b42b610d00c9b2a1","55ba5b8c04775a2f0062813d"],"title":"Rpc Endpoints","slug":"api-tokens-endpoints","order":3,"from_sync":false,"reference":false,"_id":"55b9611fb42b610d00c9b291","__v":2,"project":"54295508cd35120800fceca2","createdAt":"2014-09-29T12:48:08.939Z","version":"55b9611eb42b610d00c9b28d"},"editedParams":true,"__v":0,"project":"54295508cd35120800fceca2","version":{"version":"2.0","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["55b9611fb42b610d00c9b28e","55b9611fb42b610d00c9b28f","55b9611fb42b610d00c9b290","55b9611fb42b610d00c9b291","55b9611fb42b610d00c9b292","55b9611fb42b610d00c9b293","55bc25ee76754617002aa893","56ae7f53be2c040d00d5a09b","56ae7f7b0c1cab0d009f65d1"],"_id":"55b9611eb42b610d00c9b28d","__v":4,"createdAt":"2015-07-29T23:26:22.532Z","project":"54295508cd35120800fceca2","releaseDate":"2015-07-29T23:26:22.532Z"},"editedParams2":true,"githubsync":"","createdAt":"2014-11-23T00:45:45.736Z","user":"542954f6cd35120800fceca0"}

get/check_username/

Checks if a username exists

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

api_token:
required
string
An api token from dashboard.justyo.co
username:
required
string
The username to check availability of

Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Result Format" } [/block] If the user **is available**: [block:code] { "codes": [ { "code": "{\"exists\": true}", "language": "json" } ] } [/block] If the user **is not available**: [block:code] { "codes": [ { "code": "{\"exists\": false}", "language": "json" } ] } [/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 }}