{"_id":"54712e39691dc8080089530f","editedParams2":true,"category":{"_id":"54295508cd35120800fceca6","version":"54295508cd35120800fceca5","__v":9,"pages":["54295509cd35120800fceca8","54295ecb8d596e080056e9cd","542960538d596e080056e9dc","543825fdf1c2391400672541","5429e1527d3ab608001b0f15","5429e183e677b00800508789","54296344de0fb20800d96280","543f549455bb1008000956fb","54712e39691dc8080089530f"],"project":"54295508cd35120800fceca2","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-09-29T12:48:08.939Z","from_sync":false,"order":3,"slug":"documentation","title":"Documentation"},"user":"542954f6cd35120800fceca0","editedParams":true,"project":"54295508cd35120800fceca2","__v":1,"githubsync":"","version":{"_id":"54295508cd35120800fceca5","project":"54295508cd35120800fceca2","__v":9,"createdAt":"2014-09-29T12:48:08.901Z","releaseDate":"2014-09-29T12:48:08.901Z","categories":["54295508cd35120800fceca6","5429e1307d3ab608001b0f14","543c975b1e6ad61400b04c79","543c976a1e6ad61400b04c7a","55b874fa8ea8d50d00922a1a","55b953a6b42b610d00c9b266","55b953b5e536930d00e36095","55b9566ce536930d00e360a7","55b95f28e512530d00a1b4d7"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":false,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":["5583b0dafb52ee0d0015cffb"],"next":{"pages":[],"description":""},"createdAt":"2014-11-23T00:45:45.736Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","try":false,"basic_auth":false,"method":"get","results":{"codes":[{"name":"Success","code":"{\"exists\": false}","language":"json","status":200},{"name":"Failure","code":"{\"exists\": true}","language":"json","status":200},{"language":"text","code":""}]},"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 }}