Classrooms

Get Classroom Details

GET
Returns the classroom details for a class code.

Query parameters

codestringRequired

The classroom’s code.

retMemberLimitdoubleOptional
limit the return number of members for the classroom

Response

This endpoint returns an object
_id
stringOptional
name
stringOptional
members
list of stringsOptional
ownerID
stringOptional
description
stringOptional
code
stringOptional
codeCamel
stringOptional
courses
list of objectsOptional
clanId
stringOptional
GET
$curl -G https://codecombat.com/api/classrooms \
> -u "<username>:<password>" \
> -d code=string \
> -d retMemberLimit=1
Response
1{
2 "_id": "string",
3 "name": "string",
4 "members": [
5 "string"
6 ],
7 "ownerID": "string",
8 "description": "string",
9 "code": "string",
10 "codeCamel": "string",
11 "courses": [
12 {
13 "_id": "string",
14 "levels": [
15 {
16 "string": {}
17 }
18 ],
19 "enrolled": [
20 "string"
21 ],
22 "instance_id": "string"
23 }
24 ],
25 "clanId": "string"
26}