Skip to main content
GET
/
classrooms
Get Classroom Details
curl --request GET \
  --url https://codecombat.com/api/classrooms \
  --header 'Authorization: Basic <encoded-value>'
{
  "_id": "<string>",
  "name": "<string>",
  "members": [
    "<string>"
  ],
  "ownerID": "<string>",
  "description": "<string>",
  "code": "<string>",
  "codeCamel": "<string>",
  "courses": [
    {
      "_id": "<string>",
      "levels": [
        {}
      ],
      "enrolled": [
        "<string>"
      ],
      "instance_id": "<string>"
    }
  ],
  "clanId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

​
code
string
required

The classroom's code.

​
retMemberLimit
number | null

limit the return number of members for the classroom

Response

200 - application/json

The classroom details.

Subset of properties listed here

​
_id
string | null
​
name
string | null
​
members
string[] | null
​
ownerID
string | null
​
description
string | null
​
code
string | null
​
codeCamel
string | null
​
courses
ClassroomResponseWithCodeCoursesItem · object[] | null
​
clanId
string | null
⌘I