Classrooms
Get Classroom Details
Returns the classroom details for a class code.
GET
/api/classrooms
Authorization*
curl --request GET \
--url https://codecombat.com/api/classrooms \
--header 'Authorization: <authorization>'
{
"_id": "string",
"clanId": "string",
"code": "string",
"codeCamel": "string",
"courses": [
{
"_id": "string",
"enrolled": [
"string"
],
"instance_id": "string",
"levels": [
"object"
]
}
],
"description": "string",
"members": [
"string"
],
"name": "string",
"ownerID": "string"
}
Authorizations
Authenticationheaderrequired
string
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Query Parameters
coderequired
string
The classroom's code
.
retMemberLimit
number
limit the return number of members for the classroom
Response
200 - application/json
_id
string
clanId
string
code
string
codeCamel
string
courses
object[]
description
string
members
string[]
name
string
ownerID
string
curl --request GET \
--url https://codecombat.com/api/classrooms \
--header 'Authorization: <authorization>'
{
"_id": "string",
"clanId": "string",
"code": "string",
"codeCamel": "string",
"courses": [
{
"_id": "string",
"enrolled": [
"string"
],
"instance_id": "string",
"levels": [
"object"
]
}
],
"description": "string",
"members": [
"string"
],
"name": "string",
"ownerID": "string"
}