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

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 }}