Get Classrooms By User

Returns a list of Classrooms this user is in (if a student) or owns (if a teacher).

GET /users/{handle}/classrooms

Try it

Get Classrooms By User

cURL

curl --request GET \
  --url https://codecombat.com/api/users/{handle}/classrooms \
  --header 'Authorization: Basic <encoded-value>'

200

[
  {
    "_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.

Path Parameters

handle · string · required

The document's _id or slug.

Query Parameters

retMemberLimit · number<double> | null

limit the return number of members for each classroom

Response

200 - application/json

The requested classrooms

_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

Show child attributes

courses. _id · string | null

courses. levels · object[] | null

courses. enrolled · string[] | null

courses. instance_id · string | null

clanId · string | null