Users
Get User
Returns a User
.
GET
/api/users/{handle}
Authorization*
curl --request GET \
--url https://codecombat.com/api/users/{handle} \
--header 'Authorization: <authorization>'
{
"_id": "string",
"email": "string",
"license": {
"active": "boolean",
"ends": "string"
},
"name": "string",
"oAuthIdentities": [
{
"id": "string",
"provider": "string"
}
],
"role": "string",
"slug": "string",
"stats": {
"concepts": "object",
"gamesCompleted": "number",
"playTime": "number"
},
"subscription": {
"active": "boolean",
"ends": "string"
}
}
Authorizations
Authenticationheaderrequired
string
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Path Parameters
handlerequired
string
The document's _id
or slug
.
Query Parameters
includePlayTime
string | null
Set to non-empty string to include stats.playTime in response
Response
200 - application/json
_id
string | null
email
string | null
license
object | null
name
string | null
oAuthIdentities
object[] | null
role
string | null
Usually either 'teacher' or 'student'
slug
string | null
stats
object | null
subscription
object | null
curl --request GET \
--url https://codecombat.com/api/users/{handle} \
--header 'Authorization: <authorization>'
{
"_id": "string",
"email": "string",
"license": {
"active": "boolean",
"ends": "string"
},
"name": "string",
"oAuthIdentities": [
{
"id": "string",
"provider": "string"
}
],
"role": "string",
"slug": "string",
"stats": {
"concepts": "object",
"gamesCompleted": "number",
"playTime": "number"
},
"subscription": {
"active": "boolean",
"ends": "string"
}
}