PostmanOpenAPIContact usSign up
  • Overview
    • Introduction
  • API Reference
    • POSTAdd Oauth2 Identity
LogoLogo
PostmanOpenAPIContact usSign up
API ReferenceClassrooms

Get Classroom Details

GET
https://codecombat.com/api/classrooms
GET
/api/classrooms
1curl -G https://codecombat.com/api/classrooms \
2     -u "<username>:<password>" \
3     -d code=string \
4     -d retMemberLimit=1
Try it
200Retrieved
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}
Returns the classroom details for a class code.
Was this page helpful?
Previous

Create a classroom

Next
Built with
Create a classroom
Returns the classroom details for a class code.

Authentication

AuthorizationBasic
Basic authentication of the form `Basic <username:password>`.

Query parameters

codestringRequired
The classroom's `code`.
retMemberLimitdoubleOptional
limit the return number of members for the classroom

Response

This endpoint returns an object.
_idstring or null
namestring or null
memberslist of strings or null
ownerIDstring or null
descriptionstring or null
codestring or null
codeCamelstring or null
courseslist of objects or null
clanIdstring or null
limit the return number of members for the classroom

Basic authentication of the form Basic <username:password>.

The classroom’s code.