Skip to content
forgit api docs

Closing down - Get a classroom

Deprecated
GET
/classrooms/{classroom_id}

[!WARNING] Closing down notice: This operation is closing down and will be removed on August 28, 2026. For more information, see the GitHub Classroom sunset notice.

Gets a GitHub Classroom classroom for the current user. Classroom will only be returned if the current user is an administrator of the GitHub Classroom.

API method documentation

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
classroom_id
required
integer

The unique identifier of the classroom.

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Response

Media type application/json
Classroom

A GitHub Classroom classroom

object
id
required

Unique identifier of the classroom.

integer
name
required

The name of the classroom.

string
archived
required

Whether classroom is archived.

boolean
organization
required
Organization Simple for Classroom

A GitHub organization.

object
id
required
integer
login
required
string
node_id
required
string
html_url
required
string format: uri
name
required
string
nullable
avatar_url
required
string
url
required

The URL of the classroom on GitHub Classroom.

string
Examples
Example default 
{
  "id": 1296269,
  "name": "Programming Elixir",
  "archived": "false,",
  "organization": {
    "id": 1,
    "login": "programming-elixir",
    "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
    "html_url": "https://github.com/programming-elixir",
    "name": "Learn how to build fault tolerant applications",
    "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4"
  },
  "url": "https://classroom.github.com/classrooms/1-programming-elixir"
}

404

Section titled “ 404 ”

Resource not found

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}

410

Section titled “ 410 ”

Gone

Media type application/json
Basic Error

Basic Error

object
message
string
documentation_url
string
url
string
status
string
Example generated 
{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}